google-apis-clouddeploy_v1 0.33.0 → 0.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -563,6 +563,376 @@ module Google
563
563
  execute_or_queue_command(command, &block)
564
564
  end
565
565
 
566
+ # Cancels an AutomationRun. The `state` of the `AutomationRun` after cancelling
567
+ # is `CANCELLED`. `CancelAutomationRun` can be called on AutomationRun in the
568
+ # state `IN_PROGRESS` and `PENDING`; AutomationRun in a different state returns
569
+ # an `FAILED_PRECONDITION` error.
570
+ # @param [String] name
571
+ # Required. Name of the `AutomationRun`. Format is projects/`project`/locations/`
572
+ # location`/deliveryPipelines/`delivery_pipeline`/automationRuns/`automation_run`
573
+ # .
574
+ # @param [Google::Apis::ClouddeployV1::CancelAutomationRunRequest] cancel_automation_run_request_object
575
+ # @param [String] fields
576
+ # Selector specifying which fields to include in a partial response.
577
+ # @param [String] quota_user
578
+ # Available to use for quota purposes for server-side applications. Can be any
579
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
580
+ # @param [Google::Apis::RequestOptions] options
581
+ # Request-specific options
582
+ #
583
+ # @yield [result, err] Result & error if block supplied
584
+ # @yieldparam result [Google::Apis::ClouddeployV1::CancelAutomationRunResponse] parsed result object
585
+ # @yieldparam err [StandardError] error object if request failed
586
+ #
587
+ # @return [Google::Apis::ClouddeployV1::CancelAutomationRunResponse]
588
+ #
589
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
590
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
591
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
592
+ def cancel_automation_run(name, cancel_automation_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
593
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
594
+ command.request_representation = Google::Apis::ClouddeployV1::CancelAutomationRunRequest::Representation
595
+ command.request_object = cancel_automation_run_request_object
596
+ command.response_representation = Google::Apis::ClouddeployV1::CancelAutomationRunResponse::Representation
597
+ command.response_class = Google::Apis::ClouddeployV1::CancelAutomationRunResponse
598
+ command.params['name'] = name unless name.nil?
599
+ command.query['fields'] = fields unless fields.nil?
600
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
601
+ execute_or_queue_command(command, &block)
602
+ end
603
+
604
+ # Gets details of a single AutomationRun.
605
+ # @param [String] name
606
+ # Required. Name of the `AutomationRun`. Format must be projects/`project`/
607
+ # locations/`location`/deliveryPipelines/`delivery_pipeline`/automationRuns/`
608
+ # automation_run`.
609
+ # @param [String] fields
610
+ # Selector specifying which fields to include in a partial response.
611
+ # @param [String] quota_user
612
+ # Available to use for quota purposes for server-side applications. Can be any
613
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
614
+ # @param [Google::Apis::RequestOptions] options
615
+ # Request-specific options
616
+ #
617
+ # @yield [result, err] Result & error if block supplied
618
+ # @yieldparam result [Google::Apis::ClouddeployV1::AutomationRun] parsed result object
619
+ # @yieldparam err [StandardError] error object if request failed
620
+ #
621
+ # @return [Google::Apis::ClouddeployV1::AutomationRun]
622
+ #
623
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
624
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
625
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
626
+ def get_project_location_delivery_pipeline_automation_run(name, fields: nil, quota_user: nil, options: nil, &block)
627
+ command = make_simple_command(:get, 'v1/{+name}', options)
628
+ command.response_representation = Google::Apis::ClouddeployV1::AutomationRun::Representation
629
+ command.response_class = Google::Apis::ClouddeployV1::AutomationRun
630
+ command.params['name'] = name unless name.nil?
631
+ command.query['fields'] = fields unless fields.nil?
632
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
633
+ execute_or_queue_command(command, &block)
634
+ end
635
+
636
+ # Lists AutomationRuns in a given project and location.
637
+ # @param [String] parent
638
+ # Required. The parent, which owns this collection of automationRuns. Format
639
+ # must be projects/`project`/locations/`location`/deliveryPipelines/`
640
+ # delivery_pipeline`.
641
+ # @param [String] filter
642
+ # Filter automationRuns to be returned. All fields can be used in the filter.
643
+ # @param [String] order_by
644
+ # Field to sort by.
645
+ # @param [Fixnum] page_size
646
+ # The maximum number of automationRuns to return. The service may return fewer
647
+ # than this value. If unspecified, at most 50 automationRuns will be returned.
648
+ # The maximum value is 1000; values above 1000 will be set to 1000.
649
+ # @param [String] page_token
650
+ # A page token, received from a previous `ListAutomationRuns` call. Provide this
651
+ # to retrieve the subsequent page. When paginating, all other provided
652
+ # parameters match the call that provided the page token.
653
+ # @param [String] fields
654
+ # Selector specifying which fields to include in a partial response.
655
+ # @param [String] quota_user
656
+ # Available to use for quota purposes for server-side applications. Can be any
657
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
658
+ # @param [Google::Apis::RequestOptions] options
659
+ # Request-specific options
660
+ #
661
+ # @yield [result, err] Result & error if block supplied
662
+ # @yieldparam result [Google::Apis::ClouddeployV1::ListAutomationRunsResponse] parsed result object
663
+ # @yieldparam err [StandardError] error object if request failed
664
+ #
665
+ # @return [Google::Apis::ClouddeployV1::ListAutomationRunsResponse]
666
+ #
667
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
668
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
669
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
670
+ def list_project_location_delivery_pipeline_automation_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
671
+ command = make_simple_command(:get, 'v1/{+parent}/automationRuns', options)
672
+ command.response_representation = Google::Apis::ClouddeployV1::ListAutomationRunsResponse::Representation
673
+ command.response_class = Google::Apis::ClouddeployV1::ListAutomationRunsResponse
674
+ command.params['parent'] = parent unless parent.nil?
675
+ command.query['filter'] = filter unless filter.nil?
676
+ command.query['orderBy'] = order_by unless order_by.nil?
677
+ command.query['pageSize'] = page_size unless page_size.nil?
678
+ command.query['pageToken'] = page_token unless page_token.nil?
679
+ command.query['fields'] = fields unless fields.nil?
680
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
681
+ execute_or_queue_command(command, &block)
682
+ end
683
+
684
+ # Creates a new Automation in a given project and location.
685
+ # @param [String] parent
686
+ # Required. The parent collection in which the `Automation` should be created.
687
+ # Format should be projects/`project_id`/locations/`location_name`/
688
+ # deliveryPipelines/`pipeline_name`.
689
+ # @param [Google::Apis::ClouddeployV1::Automation] automation_object
690
+ # @param [String] automation_id
691
+ # Required. ID of the `Automation`.
692
+ # @param [String] request_id
693
+ # Optional. A request ID to identify requests. Specify a unique request ID so
694
+ # that if you must retry your request, the server will know to ignore the
695
+ # request if it has already been completed. The server will guarantee that for
696
+ # at least 60 minutes since the first request. For example, consider a situation
697
+ # where you make an initial request and the request times out. If you make the
698
+ # request again with the same request ID, the server can check if original
699
+ # operation with the same request ID was received, and if so, will ignore the
700
+ # second request. This prevents clients from accidentally creating duplicate
701
+ # commitments. The request ID must be a valid UUID with the exception that zero
702
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
703
+ # @param [Boolean] validate_only
704
+ # Optional. If set to true, the request is validated and the user is provided
705
+ # with an expected result, but no actual change is made.
706
+ # @param [String] fields
707
+ # Selector specifying which fields to include in a partial response.
708
+ # @param [String] quota_user
709
+ # Available to use for quota purposes for server-side applications. Can be any
710
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
711
+ # @param [Google::Apis::RequestOptions] options
712
+ # Request-specific options
713
+ #
714
+ # @yield [result, err] Result & error if block supplied
715
+ # @yieldparam result [Google::Apis::ClouddeployV1::Operation] parsed result object
716
+ # @yieldparam err [StandardError] error object if request failed
717
+ #
718
+ # @return [Google::Apis::ClouddeployV1::Operation]
719
+ #
720
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
721
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
722
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
723
+ def create_project_location_delivery_pipeline_automation(parent, automation_object = nil, automation_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
724
+ command = make_simple_command(:post, 'v1/{+parent}/automations', options)
725
+ command.request_representation = Google::Apis::ClouddeployV1::Automation::Representation
726
+ command.request_object = automation_object
727
+ command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
728
+ command.response_class = Google::Apis::ClouddeployV1::Operation
729
+ command.params['parent'] = parent unless parent.nil?
730
+ command.query['automationId'] = automation_id unless automation_id.nil?
731
+ command.query['requestId'] = request_id unless request_id.nil?
732
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
733
+ command.query['fields'] = fields unless fields.nil?
734
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
735
+ execute_or_queue_command(command, &block)
736
+ end
737
+
738
+ # Deletes a single Automation resource.
739
+ # @param [String] name
740
+ # Required. The name of the `Automation` to delete. Format should be projects/`
741
+ # project_id`/locations/`location_name`/deliveryPipelines/`pipeline_name`/
742
+ # automations/`automation_name`.
743
+ # @param [Boolean] allow_missing
744
+ # Optional. If set to true, then deleting an already deleted or non-existing `
745
+ # Automation` will succeed.
746
+ # @param [String] etag
747
+ # Optional. The weak etag of the request. This checksum is computed by the
748
+ # server based on the value of other fields, and may be sent on update and
749
+ # delete requests to ensure the client has an up-to-date value before proceeding.
750
+ # @param [String] request_id
751
+ # Optional. A request ID to identify requests. Specify a unique request ID so
752
+ # that if you must retry your request, the server will know to ignore the
753
+ # request if it has already been completed. The server will guarantee that for
754
+ # at least 60 minutes after the first request. For example, consider a situation
755
+ # where you make an initial request and the request times out. If you make the
756
+ # request again with the same request ID, the server can check if original
757
+ # operation with the same request ID was received, and if so, will ignore the
758
+ # second request. This prevents clients from accidentally creating duplicate
759
+ # commitments. The request ID must be a valid UUID with the exception that zero
760
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
761
+ # @param [Boolean] validate_only
762
+ # Optional. If set, validate the request and verify whether the resource exists,
763
+ # but do not actually post it.
764
+ # @param [String] fields
765
+ # Selector specifying which fields to include in a partial response.
766
+ # @param [String] quota_user
767
+ # Available to use for quota purposes for server-side applications. Can be any
768
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
769
+ # @param [Google::Apis::RequestOptions] options
770
+ # Request-specific options
771
+ #
772
+ # @yield [result, err] Result & error if block supplied
773
+ # @yieldparam result [Google::Apis::ClouddeployV1::Operation] parsed result object
774
+ # @yieldparam err [StandardError] error object if request failed
775
+ #
776
+ # @return [Google::Apis::ClouddeployV1::Operation]
777
+ #
778
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
779
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
780
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
781
+ def delete_project_location_delivery_pipeline_automation(name, allow_missing: nil, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
782
+ command = make_simple_command(:delete, 'v1/{+name}', options)
783
+ command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
784
+ command.response_class = Google::Apis::ClouddeployV1::Operation
785
+ command.params['name'] = name unless name.nil?
786
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
787
+ command.query['etag'] = etag unless etag.nil?
788
+ command.query['requestId'] = request_id unless request_id.nil?
789
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
790
+ command.query['fields'] = fields unless fields.nil?
791
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
792
+ execute_or_queue_command(command, &block)
793
+ end
794
+
795
+ # Gets details of a single Automation.
796
+ # @param [String] name
797
+ # Required. Name of the `Automation`. Format must be projects/`project_id`/
798
+ # locations/`location_name`/deliveryPipelines/`pipeline_name`/automations/`
799
+ # automation_name`.
800
+ # @param [String] fields
801
+ # Selector specifying which fields to include in a partial response.
802
+ # @param [String] quota_user
803
+ # Available to use for quota purposes for server-side applications. Can be any
804
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
805
+ # @param [Google::Apis::RequestOptions] options
806
+ # Request-specific options
807
+ #
808
+ # @yield [result, err] Result & error if block supplied
809
+ # @yieldparam result [Google::Apis::ClouddeployV1::Automation] parsed result object
810
+ # @yieldparam err [StandardError] error object if request failed
811
+ #
812
+ # @return [Google::Apis::ClouddeployV1::Automation]
813
+ #
814
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
815
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
816
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
817
+ def get_project_location_delivery_pipeline_automation(name, fields: nil, quota_user: nil, options: nil, &block)
818
+ command = make_simple_command(:get, 'v1/{+name}', options)
819
+ command.response_representation = Google::Apis::ClouddeployV1::Automation::Representation
820
+ command.response_class = Google::Apis::ClouddeployV1::Automation
821
+ command.params['name'] = name unless name.nil?
822
+ command.query['fields'] = fields unless fields.nil?
823
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
824
+ execute_or_queue_command(command, &block)
825
+ end
826
+
827
+ # Lists Automations in a given project and location.
828
+ # @param [String] parent
829
+ # Required. The parent, which owns this collection of automations. Format must
830
+ # be projects/`project_id`/locations/`location_name`/deliveryPipelines/`
831
+ # pipeline_name`.
832
+ # @param [String] filter
833
+ # Filter automations to be returned. All fields can be used in the filter.
834
+ # @param [String] order_by
835
+ # Field to sort by.
836
+ # @param [Fixnum] page_size
837
+ # The maximum number of automations to return. The service may return fewer than
838
+ # this value. If unspecified, at most 50 automations will be returned. The
839
+ # maximum value is 1000; values above 1000 will be set to 1000.
840
+ # @param [String] page_token
841
+ # A page token, received from a previous `ListAutomations` call. Provide this to
842
+ # retrieve the subsequent page. When paginating, all other provided parameters
843
+ # match the call that provided the page token.
844
+ # @param [String] fields
845
+ # Selector specifying which fields to include in a partial response.
846
+ # @param [String] quota_user
847
+ # Available to use for quota purposes for server-side applications. Can be any
848
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
849
+ # @param [Google::Apis::RequestOptions] options
850
+ # Request-specific options
851
+ #
852
+ # @yield [result, err] Result & error if block supplied
853
+ # @yieldparam result [Google::Apis::ClouddeployV1::ListAutomationsResponse] parsed result object
854
+ # @yieldparam err [StandardError] error object if request failed
855
+ #
856
+ # @return [Google::Apis::ClouddeployV1::ListAutomationsResponse]
857
+ #
858
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
859
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
860
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
861
+ def list_project_location_delivery_pipeline_automations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
862
+ command = make_simple_command(:get, 'v1/{+parent}/automations', options)
863
+ command.response_representation = Google::Apis::ClouddeployV1::ListAutomationsResponse::Representation
864
+ command.response_class = Google::Apis::ClouddeployV1::ListAutomationsResponse
865
+ command.params['parent'] = parent unless parent.nil?
866
+ command.query['filter'] = filter unless filter.nil?
867
+ command.query['orderBy'] = order_by unless order_by.nil?
868
+ command.query['pageSize'] = page_size unless page_size.nil?
869
+ command.query['pageToken'] = page_token unless page_token.nil?
870
+ command.query['fields'] = fields unless fields.nil?
871
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
872
+ execute_or_queue_command(command, &block)
873
+ end
874
+
875
+ # Updates the parameters of a single Automation resource.
876
+ # @param [String] name
877
+ # Output only. Name of the `Automation`. Format is projects/`project`/locations/`
878
+ # location`/deliveryPipelines/`delivery_pipeline`/automations/`automation`.
879
+ # @param [Google::Apis::ClouddeployV1::Automation] automation_object
880
+ # @param [Boolean] allow_missing
881
+ # Optional. If set to true, updating a `Automation` that does not exist will
882
+ # result in the creation of a new `Automation`.
883
+ # @param [String] request_id
884
+ # Optional. A request ID to identify requests. Specify a unique request ID so
885
+ # that if you must retry your request, the server will know to ignore the
886
+ # request if it has already been completed. The server will guarantee that for
887
+ # at least 60 minutes since the first request. For example, consider a situation
888
+ # where you make an initial request and the request times out. If you make the
889
+ # request again with the same request ID, the server can check if original
890
+ # operation with the same request ID was received, and if so, will ignore the
891
+ # second request. This prevents clients from accidentally creating duplicate
892
+ # commitments. The request ID must be a valid UUID with the exception that zero
893
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
894
+ # @param [String] update_mask
895
+ # Required. Field mask is used to specify the fields to be overwritten in the `
896
+ # Automation` resource by the update. The fields specified in the update_mask
897
+ # are relative to the resource, not the full request. A field will be
898
+ # overwritten if it is in the mask. If the user does not provide a mask then all
899
+ # fields will be overwritten.
900
+ # @param [Boolean] validate_only
901
+ # Optional. If set to true, the request is validated and the user is provided
902
+ # with an expected result, but no actual change is made.
903
+ # @param [String] fields
904
+ # Selector specifying which fields to include in a partial response.
905
+ # @param [String] quota_user
906
+ # Available to use for quota purposes for server-side applications. Can be any
907
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
908
+ # @param [Google::Apis::RequestOptions] options
909
+ # Request-specific options
910
+ #
911
+ # @yield [result, err] Result & error if block supplied
912
+ # @yieldparam result [Google::Apis::ClouddeployV1::Operation] parsed result object
913
+ # @yieldparam err [StandardError] error object if request failed
914
+ #
915
+ # @return [Google::Apis::ClouddeployV1::Operation]
916
+ #
917
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
918
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
919
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
920
+ def patch_project_location_delivery_pipeline_automation(name, automation_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
921
+ command = make_simple_command(:patch, 'v1/{+name}', options)
922
+ command.request_representation = Google::Apis::ClouddeployV1::Automation::Representation
923
+ command.request_object = automation_object
924
+ command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
925
+ command.response_class = Google::Apis::ClouddeployV1::Operation
926
+ command.params['name'] = name unless name.nil?
927
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
928
+ command.query['requestId'] = request_id unless request_id.nil?
929
+ command.query['updateMask'] = update_mask unless update_mask.nil?
930
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
931
+ command.query['fields'] = fields unless fields.nil?
932
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
933
+ execute_or_queue_command(command, &block)
934
+ end
935
+
566
936
  # Abandons a Release in the Delivery Pipeline.
567
937
  # @param [String] name
568
938
  # Required. Name of the Release. Format is projects/`project`/locations/`
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-clouddeploy_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.33.0
4
+ version: 0.35.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-29 00:00:00.000000000 Z
11
+ date: 2023-11-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-clouddeploy_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-clouddeploy_v1/v0.33.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-clouddeploy_v1/v0.35.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-clouddeploy_v1
63
63
  post_install_message:
64
64
  rdoc_options: []