GoogleCloudEventarcV1PipelineDestination.php 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <?php
  2. /*
  3. * Copyright 2014 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  6. * use this file except in compliance with the License. You may obtain a copy of
  7. * the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14. * License for the specific language governing permissions and limitations under
  15. * the License.
  16. */
  17. namespace Google\Service\Eventarc;
  18. class GoogleCloudEventarcV1PipelineDestination extends \Google\Model
  19. {
  20. protected $authenticationConfigType = GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig::class;
  21. protected $authenticationConfigDataType = '';
  22. protected $httpEndpointType = GoogleCloudEventarcV1PipelineDestinationHttpEndpoint::class;
  23. protected $httpEndpointDataType = '';
  24. /**
  25. * Optional. The resource name of the Message Bus to which events should be
  26. * published. The Message Bus resource should exist in the same project as the
  27. * Pipeline. Format:
  28. * `projects/{project}/locations/{location}/messageBuses/{message_bus}`
  29. *
  30. * @var string
  31. */
  32. public $messageBus;
  33. protected $networkConfigType = GoogleCloudEventarcV1PipelineDestinationNetworkConfig::class;
  34. protected $networkConfigDataType = '';
  35. protected $outputPayloadFormatType = GoogleCloudEventarcV1PipelineMessagePayloadFormat::class;
  36. protected $outputPayloadFormatDataType = '';
  37. /**
  38. * Optional. The resource name of the Pub/Sub topic to which events should be
  39. * published. Format: `projects/{project}/locations/{location}/topics/{topic}`
  40. *
  41. * @var string
  42. */
  43. public $topic;
  44. /**
  45. * Optional. The resource name of the Workflow whose Executions are triggered
  46. * by the events. The Workflow resource should be deployed in the same project
  47. * as the Pipeline. Format:
  48. * `projects/{project}/locations/{location}/workflows/{workflow}`
  49. *
  50. * @var string
  51. */
  52. public $workflow;
  53. /**
  54. * Optional. An authentication config used to authenticate message requests,
  55. * such that destinations can verify the source. For example, this can be used
  56. * with private Google Cloud destinations that require Google Cloud
  57. * credentials for access like Cloud Run. This field is optional and should be
  58. * set only by users interested in authenticated push.
  59. *
  60. * @param GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig $authenticationConfig
  61. */
  62. public function setAuthenticationConfig(GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig $authenticationConfig)
  63. {
  64. $this->authenticationConfig = $authenticationConfig;
  65. }
  66. /**
  67. * @return GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig
  68. */
  69. public function getAuthenticationConfig()
  70. {
  71. return $this->authenticationConfig;
  72. }
  73. /**
  74. * Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN
  75. * is provided as the endpoint, Pipeline will create a peering zone to the
  76. * consumer VPC and forward DNS requests to the VPC specified by network
  77. * config to resolve the service endpoint. See:
  78. * https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones
  79. *
  80. * @param GoogleCloudEventarcV1PipelineDestinationHttpEndpoint $httpEndpoint
  81. */
  82. public function setHttpEndpoint(GoogleCloudEventarcV1PipelineDestinationHttpEndpoint $httpEndpoint)
  83. {
  84. $this->httpEndpoint = $httpEndpoint;
  85. }
  86. /**
  87. * @return GoogleCloudEventarcV1PipelineDestinationHttpEndpoint
  88. */
  89. public function getHttpEndpoint()
  90. {
  91. return $this->httpEndpoint;
  92. }
  93. /**
  94. * Optional. The resource name of the Message Bus to which events should be
  95. * published. The Message Bus resource should exist in the same project as the
  96. * Pipeline. Format:
  97. * `projects/{project}/locations/{location}/messageBuses/{message_bus}`
  98. *
  99. * @param string $messageBus
  100. */
  101. public function setMessageBus($messageBus)
  102. {
  103. $this->messageBus = $messageBus;
  104. }
  105. /**
  106. * @return string
  107. */
  108. public function getMessageBus()
  109. {
  110. return $this->messageBus;
  111. }
  112. /**
  113. * Optional. Network config is used to configure how Pipeline resolves and
  114. * connects to a destination.
  115. *
  116. * @param GoogleCloudEventarcV1PipelineDestinationNetworkConfig $networkConfig
  117. */
  118. public function setNetworkConfig(GoogleCloudEventarcV1PipelineDestinationNetworkConfig $networkConfig)
  119. {
  120. $this->networkConfig = $networkConfig;
  121. }
  122. /**
  123. * @return GoogleCloudEventarcV1PipelineDestinationNetworkConfig
  124. */
  125. public function getNetworkConfig()
  126. {
  127. return $this->networkConfig;
  128. }
  129. /**
  130. * Optional. The message format before it is delivered to the destination. If
  131. * not set, the message will be delivered in the format it was originally
  132. * delivered to the Pipeline. This field can only be set if
  133. * Pipeline.input_payload_format is also set.
  134. *
  135. * @param GoogleCloudEventarcV1PipelineMessagePayloadFormat $outputPayloadFormat
  136. */
  137. public function setOutputPayloadFormat(GoogleCloudEventarcV1PipelineMessagePayloadFormat $outputPayloadFormat)
  138. {
  139. $this->outputPayloadFormat = $outputPayloadFormat;
  140. }
  141. /**
  142. * @return GoogleCloudEventarcV1PipelineMessagePayloadFormat
  143. */
  144. public function getOutputPayloadFormat()
  145. {
  146. return $this->outputPayloadFormat;
  147. }
  148. /**
  149. * Optional. The resource name of the Pub/Sub topic to which events should be
  150. * published. Format: `projects/{project}/locations/{location}/topics/{topic}`
  151. *
  152. * @param string $topic
  153. */
  154. public function setTopic($topic)
  155. {
  156. $this->topic = $topic;
  157. }
  158. /**
  159. * @return string
  160. */
  161. public function getTopic()
  162. {
  163. return $this->topic;
  164. }
  165. /**
  166. * Optional. The resource name of the Workflow whose Executions are triggered
  167. * by the events. The Workflow resource should be deployed in the same project
  168. * as the Pipeline. Format:
  169. * `projects/{project}/locations/{location}/workflows/{workflow}`
  170. *
  171. * @param string $workflow
  172. */
  173. public function setWorkflow($workflow)
  174. {
  175. $this->workflow = $workflow;
  176. }
  177. /**
  178. * @return string
  179. */
  180. public function getWorkflow()
  181. {
  182. return $this->workflow;
  183. }
  184. }
  185. // Adding a class alias for backwards compatibility with the previous class name.
  186. class_alias(GoogleCloudEventarcV1PipelineDestination::class, 'Google_Service_Eventarc_GoogleCloudEventarcV1PipelineDestination');