Class: Google::Apis::EventarcV1beta1::EventarcService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::EventarcV1beta1::EventarcService
- Defined in:
- lib/google/apis/eventarc_v1beta1/service.rb
Overview
Eventarc API
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#create_project_location_trigger(parent, trigger_object = nil, trigger_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Create a new trigger in a particular project and location.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Empty
Deletes a long-running operation.
-
#delete_project_location_trigger(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Delete a single trigger.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Location
Gets information about a location.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Gets the latest state of a long-running operation.
-
#get_project_location_trigger(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Trigger
Get a single trigger.
-
#get_project_location_trigger_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Policy
Gets the access control policy for a resource.
-
#initialize ⇒ EventarcService
constructor
A new instance of EventarcService.
-
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_triggers(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::ListTriggersResponse
List triggers.
-
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::ListLocationsResponse
Lists information about the supported locations for this service.
-
#patch_project_location_trigger(name, trigger_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Update a single trigger.
-
#set_trigger_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Policy
Sets the access control policy on the specified resource.
-
#test_trigger_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.
Constructor Details
#initialize ⇒ EventarcService
Returns a new instance of EventarcService.
45 46 47 48 49 50 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 45 def initialize super('https://eventarc.googleapis.com/', '', client_name: 'google-apis-eventarc_v1beta1', client_version: Google::Apis::EventarcV1beta1::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Empty
Starts asynchronous cancellation on a long-running operation. The server makes
a best effort to cancel the operation, but success is not guaranteed. If the
server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Clients can use Operations.GetOperation or other methods to check whether the
cancellation succeeded or whether the operation completed despite cancellation.
On successful cancellation, the operation is not deleted; instead, it becomes
an operation with an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 153 def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:cancel', ) command.request_representation = Google::Apis::EventarcV1beta1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::EventarcV1beta1::Empty::Representation command.response_class = Google::Apis::EventarcV1beta1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_trigger(parent, trigger_object = nil, trigger_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Create a new trigger in a particular project and location.
301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 301 def create_project_location_trigger(parent, trigger_object = nil, trigger_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/triggers', ) command.request_representation = Google::Apis::EventarcV1beta1::Trigger::Representation command.request_object = trigger_object command.response_representation = Google::Apis::EventarcV1beta1::Operation::Representation command.response_class = Google::Apis::EventarcV1beta1::Operation command.params['parent'] = parent unless parent.nil? command.query['triggerId'] = trigger_id unless trigger_id.nil? command.query['validateOnly'] = validate_only unless validate_only.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Empty
Deletes a long-running operation. This method indicates that the client is no
longer interested in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns google.rpc.Code.
UNIMPLEMENTED
.
188 189 190 191 192 193 194 195 196 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 188 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::EventarcV1beta1::Empty::Representation command.response_class = Google::Apis::EventarcV1beta1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_trigger(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Delete a single trigger.
344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 344 def delete_project_location_trigger(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::EventarcV1beta1::Operation::Representation command.response_class = Google::Apis::EventarcV1beta1::Operation command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['etag'] = etag unless etag.nil? command.query['validateOnly'] = validate_only unless validate_only.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Location
Gets information about a location.
72 73 74 75 76 77 78 79 80 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 72 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::EventarcV1beta1::Location::Representation command.response_class = Google::Apis::EventarcV1beta1::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
219 220 221 222 223 224 225 226 227 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 219 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::EventarcV1beta1::Operation::Representation command.response_class = Google::Apis::EventarcV1beta1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_trigger(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Trigger
Get a single trigger.
377 378 379 380 381 382 383 384 385 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 377 def get_project_location_trigger(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::EventarcV1beta1::Trigger::Representation command.response_class = Google::Apis::EventarcV1beta1::Trigger command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_trigger_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
420 421 422 423 424 425 426 427 428 429 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 420 def get_project_location_trigger_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', ) command.response_representation = Google::Apis::EventarcV1beta1::Policy::Representation command.response_class = Google::Apis::EventarcV1beta1::Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::ListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource
name schemes, such as users/*/operations
. To override the binding, API
services can add a binding such as "/v1/
name=users/*/operations"
to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 262 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}/operations', ) command.response_representation = Google::Apis::EventarcV1beta1::ListOperationsResponse::Representation command.response_class = Google::Apis::EventarcV1beta1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_triggers(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::ListTriggersResponse
List triggers.
464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 464 def list_project_location_triggers(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/triggers', ) command.response_representation = Google::Apis::EventarcV1beta1::ListTriggersResponse::Representation command.response_class = Google::Apis::EventarcV1beta1::ListTriggersResponse command.params['parent'] = parent unless parent.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::ListLocationsResponse
Lists information about the supported locations for this service.
112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 112 def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}/locations', ) command.response_representation = Google::Apis::EventarcV1beta1::ListLocationsResponse::Representation command.response_class = Google::Apis::EventarcV1beta1::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_trigger(name, trigger_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Operation
Update a single trigger.
510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 510 def patch_project_location_trigger(name, trigger_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta1/{+name}', ) command.request_representation = Google::Apis::EventarcV1beta1::Trigger::Representation command.request_object = trigger_object command.response_representation = Google::Apis::EventarcV1beta1::Operation::Representation command.response_class = Google::Apis::EventarcV1beta1::Operation command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['validateOnly'] = validate_only unless validate_only.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_trigger_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::Policy
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors.
549 550 551 552 553 554 555 556 557 558 559 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 549 def set_trigger_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::EventarcV1beta1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::EventarcV1beta1::Policy::Representation command.response_class = Google::Apis::EventarcV1beta1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_trigger_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::EventarcV1beta1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND
error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning.
587 588 589 590 591 592 593 594 595 596 597 |
# File 'lib/google/apis/eventarc_v1beta1/service.rb', line 587 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::EventarcV1beta1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::EventarcV1beta1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::EventarcV1beta1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |