google-apis-dataproc_v1 0.52.0 → 0.54.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.
@@ -665,6 +665,375 @@ module Google
665
665
  execute_or_queue_command(command, &block)
666
666
  end
667
667
 
668
+ # Create a session template synchronously.
669
+ # @param [String] parent
670
+ # Required. The parent resource where this session template will be created.
671
+ # @param [Google::Apis::DataprocV1::SessionTemplate] session_template_object
672
+ # @param [String] fields
673
+ # Selector specifying which fields to include in a partial response.
674
+ # @param [String] quota_user
675
+ # Available to use for quota purposes for server-side applications. Can be any
676
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
677
+ # @param [Google::Apis::RequestOptions] options
678
+ # Request-specific options
679
+ #
680
+ # @yield [result, err] Result & error if block supplied
681
+ # @yieldparam result [Google::Apis::DataprocV1::SessionTemplate] parsed result object
682
+ # @yieldparam err [StandardError] error object if request failed
683
+ #
684
+ # @return [Google::Apis::DataprocV1::SessionTemplate]
685
+ #
686
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
687
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
688
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
689
+ def create_project_location_session_template(parent, session_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
690
+ command = make_simple_command(:post, 'v1/{+parent}/sessionTemplates', options)
691
+ command.request_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
692
+ command.request_object = session_template_object
693
+ command.response_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
694
+ command.response_class = Google::Apis::DataprocV1::SessionTemplate
695
+ command.params['parent'] = parent unless parent.nil?
696
+ command.query['fields'] = fields unless fields.nil?
697
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
698
+ execute_or_queue_command(command, &block)
699
+ end
700
+
701
+ # Deletes a session template.
702
+ # @param [String] name
703
+ # Required. The name of the session template resource to delete.
704
+ # @param [String] fields
705
+ # Selector specifying which fields to include in a partial response.
706
+ # @param [String] quota_user
707
+ # Available to use for quota purposes for server-side applications. Can be any
708
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
709
+ # @param [Google::Apis::RequestOptions] options
710
+ # Request-specific options
711
+ #
712
+ # @yield [result, err] Result & error if block supplied
713
+ # @yieldparam result [Google::Apis::DataprocV1::Empty] parsed result object
714
+ # @yieldparam err [StandardError] error object if request failed
715
+ #
716
+ # @return [Google::Apis::DataprocV1::Empty]
717
+ #
718
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
719
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
720
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
721
+ def delete_project_location_session_template(name, fields: nil, quota_user: nil, options: nil, &block)
722
+ command = make_simple_command(:delete, 'v1/{+name}', options)
723
+ command.response_representation = Google::Apis::DataprocV1::Empty::Representation
724
+ command.response_class = Google::Apis::DataprocV1::Empty
725
+ command.params['name'] = name unless name.nil?
726
+ command.query['fields'] = fields unless fields.nil?
727
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
728
+ execute_or_queue_command(command, &block)
729
+ end
730
+
731
+ # Gets the resource representation for a session template.
732
+ # @param [String] name
733
+ # Required. The name of the session template to retrieve.
734
+ # @param [String] fields
735
+ # Selector specifying which fields to include in a partial response.
736
+ # @param [String] quota_user
737
+ # Available to use for quota purposes for server-side applications. Can be any
738
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
739
+ # @param [Google::Apis::RequestOptions] options
740
+ # Request-specific options
741
+ #
742
+ # @yield [result, err] Result & error if block supplied
743
+ # @yieldparam result [Google::Apis::DataprocV1::SessionTemplate] parsed result object
744
+ # @yieldparam err [StandardError] error object if request failed
745
+ #
746
+ # @return [Google::Apis::DataprocV1::SessionTemplate]
747
+ #
748
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
749
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
750
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
751
+ def get_project_location_session_template(name, fields: nil, quota_user: nil, options: nil, &block)
752
+ command = make_simple_command(:get, 'v1/{+name}', options)
753
+ command.response_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
754
+ command.response_class = Google::Apis::DataprocV1::SessionTemplate
755
+ command.params['name'] = name unless name.nil?
756
+ command.query['fields'] = fields unless fields.nil?
757
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
758
+ execute_or_queue_command(command, &block)
759
+ end
760
+
761
+ # Lists session templates.
762
+ # @param [String] parent
763
+ # Required. The parent that owns this collection of session templates.
764
+ # @param [String] filter
765
+ # Optional. A filter for the session templates to return in the response.
766
+ # Filters are case sensitive and have the following syntax:field = value AND
767
+ # field = value ...
768
+ # @param [Fixnum] page_size
769
+ # Optional. The maximum number of sessions to return in each response. The
770
+ # service may return fewer than this value.
771
+ # @param [String] page_token
772
+ # Optional. A page token received from a previous ListSessions call. Provide
773
+ # this token to retrieve the subsequent page.
774
+ # @param [String] fields
775
+ # Selector specifying which fields to include in a partial response.
776
+ # @param [String] quota_user
777
+ # Available to use for quota purposes for server-side applications. Can be any
778
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
779
+ # @param [Google::Apis::RequestOptions] options
780
+ # Request-specific options
781
+ #
782
+ # @yield [result, err] Result & error if block supplied
783
+ # @yieldparam result [Google::Apis::DataprocV1::ListSessionTemplatesResponse] parsed result object
784
+ # @yieldparam err [StandardError] error object if request failed
785
+ #
786
+ # @return [Google::Apis::DataprocV1::ListSessionTemplatesResponse]
787
+ #
788
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
789
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
790
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
791
+ def list_project_location_session_templates(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
792
+ command = make_simple_command(:get, 'v1/{+parent}/sessionTemplates', options)
793
+ command.response_representation = Google::Apis::DataprocV1::ListSessionTemplatesResponse::Representation
794
+ command.response_class = Google::Apis::DataprocV1::ListSessionTemplatesResponse
795
+ command.params['parent'] = parent unless parent.nil?
796
+ command.query['filter'] = filter unless filter.nil?
797
+ command.query['pageSize'] = page_size unless page_size.nil?
798
+ command.query['pageToken'] = page_token unless page_token.nil?
799
+ command.query['fields'] = fields unless fields.nil?
800
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
801
+ execute_or_queue_command(command, &block)
802
+ end
803
+
804
+ # Updates the session template synchronously.
805
+ # @param [String] name
806
+ # Required. The resource name of the session template.
807
+ # @param [Google::Apis::DataprocV1::SessionTemplate] session_template_object
808
+ # @param [String] fields
809
+ # Selector specifying which fields to include in a partial response.
810
+ # @param [String] quota_user
811
+ # Available to use for quota purposes for server-side applications. Can be any
812
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
813
+ # @param [Google::Apis::RequestOptions] options
814
+ # Request-specific options
815
+ #
816
+ # @yield [result, err] Result & error if block supplied
817
+ # @yieldparam result [Google::Apis::DataprocV1::SessionTemplate] parsed result object
818
+ # @yieldparam err [StandardError] error object if request failed
819
+ #
820
+ # @return [Google::Apis::DataprocV1::SessionTemplate]
821
+ #
822
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
823
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
824
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
825
+ def patch_project_location_session_template(name, session_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
826
+ command = make_simple_command(:patch, 'v1/{+name}', options)
827
+ command.request_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
828
+ command.request_object = session_template_object
829
+ command.response_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
830
+ command.response_class = Google::Apis::DataprocV1::SessionTemplate
831
+ command.params['name'] = name unless name.nil?
832
+ command.query['fields'] = fields unless fields.nil?
833
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
834
+ execute_or_queue_command(command, &block)
835
+ end
836
+
837
+ # Create an interactive session asynchronously.
838
+ # @param [String] parent
839
+ # Required. The parent resource where this session will be created.
840
+ # @param [Google::Apis::DataprocV1::Session] session_object
841
+ # @param [String] request_id
842
+ # Optional. A unique ID used to identify the request. If the service receives
843
+ # two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/
844
+ # rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s
845
+ # with the same ID, the second request is ignored, and the first Session is
846
+ # created and stored in the backend.Recommendation: Set this value to a UUID (
847
+ # https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must
848
+ # contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-
849
+ # ). The maximum length is 40 characters.
850
+ # @param [String] session_id
851
+ # Required. The ID to use for the session, which becomes the final component of
852
+ # the session's resource name.This value must be 4-63 characters. Valid
853
+ # characters are /a-z-/.
854
+ # @param [String] fields
855
+ # Selector specifying which fields to include in a partial response.
856
+ # @param [String] quota_user
857
+ # Available to use for quota purposes for server-side applications. Can be any
858
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
859
+ # @param [Google::Apis::RequestOptions] options
860
+ # Request-specific options
861
+ #
862
+ # @yield [result, err] Result & error if block supplied
863
+ # @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
864
+ # @yieldparam err [StandardError] error object if request failed
865
+ #
866
+ # @return [Google::Apis::DataprocV1::Operation]
867
+ #
868
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
869
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
870
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
871
+ def create_project_location_session(parent, session_object = nil, request_id: nil, session_id: nil, fields: nil, quota_user: nil, options: nil, &block)
872
+ command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
873
+ command.request_representation = Google::Apis::DataprocV1::Session::Representation
874
+ command.request_object = session_object
875
+ command.response_representation = Google::Apis::DataprocV1::Operation::Representation
876
+ command.response_class = Google::Apis::DataprocV1::Operation
877
+ command.params['parent'] = parent unless parent.nil?
878
+ command.query['requestId'] = request_id unless request_id.nil?
879
+ command.query['sessionId'] = session_id unless session_id.nil?
880
+ command.query['fields'] = fields unless fields.nil?
881
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
882
+ execute_or_queue_command(command, &block)
883
+ end
884
+
885
+ # Deletes the interactive session resource. If the session is not in terminal
886
+ # state, it is terminated, and then deleted.
887
+ # @param [String] name
888
+ # Required. The name of the session resource to delete.
889
+ # @param [String] request_id
890
+ # Optional. A unique ID used to identify the request. If the service receives
891
+ # two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/
892
+ # google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with
893
+ # the same ID, the second request is ignored.Recommendation: Set this value to a
894
+ # UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value
895
+ # must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
896
+ # hyphens (-). The maximum length is 40 characters.
897
+ # @param [String] fields
898
+ # Selector specifying which fields to include in a partial response.
899
+ # @param [String] quota_user
900
+ # Available to use for quota purposes for server-side applications. Can be any
901
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
902
+ # @param [Google::Apis::RequestOptions] options
903
+ # Request-specific options
904
+ #
905
+ # @yield [result, err] Result & error if block supplied
906
+ # @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
907
+ # @yieldparam err [StandardError] error object if request failed
908
+ #
909
+ # @return [Google::Apis::DataprocV1::Operation]
910
+ #
911
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
912
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
913
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
914
+ def delete_project_location_session(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
915
+ command = make_simple_command(:delete, 'v1/{+name}', options)
916
+ command.response_representation = Google::Apis::DataprocV1::Operation::Representation
917
+ command.response_class = Google::Apis::DataprocV1::Operation
918
+ command.params['name'] = name unless name.nil?
919
+ command.query['requestId'] = request_id unless request_id.nil?
920
+ command.query['fields'] = fields unless fields.nil?
921
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
922
+ execute_or_queue_command(command, &block)
923
+ end
924
+
925
+ # Gets the resource representation for an interactive session.
926
+ # @param [String] name
927
+ # Required. The name of the session to retrieve.
928
+ # @param [String] fields
929
+ # Selector specifying which fields to include in a partial response.
930
+ # @param [String] quota_user
931
+ # Available to use for quota purposes for server-side applications. Can be any
932
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
933
+ # @param [Google::Apis::RequestOptions] options
934
+ # Request-specific options
935
+ #
936
+ # @yield [result, err] Result & error if block supplied
937
+ # @yieldparam result [Google::Apis::DataprocV1::Session] parsed result object
938
+ # @yieldparam err [StandardError] error object if request failed
939
+ #
940
+ # @return [Google::Apis::DataprocV1::Session]
941
+ #
942
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
943
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
944
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
945
+ def get_project_location_session(name, fields: nil, quota_user: nil, options: nil, &block)
946
+ command = make_simple_command(:get, 'v1/{+name}', options)
947
+ command.response_representation = Google::Apis::DataprocV1::Session::Representation
948
+ command.response_class = Google::Apis::DataprocV1::Session
949
+ command.params['name'] = name unless name.nil?
950
+ command.query['fields'] = fields unless fields.nil?
951
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
952
+ execute_or_queue_command(command, &block)
953
+ end
954
+
955
+ # Lists interactive sessions.
956
+ # @param [String] parent
957
+ # Required. The parent, which owns this collection of sessions.
958
+ # @param [String] filter
959
+ # Optional. A filter for the sessions to return in the response.A filter is a
960
+ # logical expression constraining the values of various fields in each session
961
+ # resource. Filters are case sensitive, and may contain multiple clauses
962
+ # combined with logical operators (AND, OR). Supported fields are session_id,
963
+ # session_uuid, state, and create_time.Example: state = ACTIVE and create_time <
964
+ # "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were
965
+ # created before 2023-01-01.See https://google.aip.dev/assets/misc/ebnf-
966
+ # filtering.txt for a detailed description of the filter syntax and a list of
967
+ # supported comparators.
968
+ # @param [Fixnum] page_size
969
+ # Optional. The maximum number of sessions to return in each response. The
970
+ # service may return fewer than this value.
971
+ # @param [String] page_token
972
+ # Optional. A page token received from a previous ListSessions call. Provide
973
+ # this token to retrieve the subsequent page.
974
+ # @param [String] fields
975
+ # Selector specifying which fields to include in a partial response.
976
+ # @param [String] quota_user
977
+ # Available to use for quota purposes for server-side applications. Can be any
978
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
979
+ # @param [Google::Apis::RequestOptions] options
980
+ # Request-specific options
981
+ #
982
+ # @yield [result, err] Result & error if block supplied
983
+ # @yieldparam result [Google::Apis::DataprocV1::ListSessionsResponse] parsed result object
984
+ # @yieldparam err [StandardError] error object if request failed
985
+ #
986
+ # @return [Google::Apis::DataprocV1::ListSessionsResponse]
987
+ #
988
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
989
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
990
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
991
+ def list_project_location_sessions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
992
+ command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
993
+ command.response_representation = Google::Apis::DataprocV1::ListSessionsResponse::Representation
994
+ command.response_class = Google::Apis::DataprocV1::ListSessionsResponse
995
+ command.params['parent'] = parent unless parent.nil?
996
+ command.query['filter'] = filter unless filter.nil?
997
+ command.query['pageSize'] = page_size unless page_size.nil?
998
+ command.query['pageToken'] = page_token unless page_token.nil?
999
+ command.query['fields'] = fields unless fields.nil?
1000
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1001
+ execute_or_queue_command(command, &block)
1002
+ end
1003
+
1004
+ # Terminates the interactive session.
1005
+ # @param [String] name
1006
+ # Required. The name of the session resource to terminate.
1007
+ # @param [Google::Apis::DataprocV1::TerminateSessionRequest] terminate_session_request_object
1008
+ # @param [String] fields
1009
+ # Selector specifying which fields to include in a partial response.
1010
+ # @param [String] quota_user
1011
+ # Available to use for quota purposes for server-side applications. Can be any
1012
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1013
+ # @param [Google::Apis::RequestOptions] options
1014
+ # Request-specific options
1015
+ #
1016
+ # @yield [result, err] Result & error if block supplied
1017
+ # @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object
1018
+ # @yieldparam err [StandardError] error object if request failed
1019
+ #
1020
+ # @return [Google::Apis::DataprocV1::Operation]
1021
+ #
1022
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1023
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1024
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1025
+ def terminate_session(name, terminate_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1026
+ command = make_simple_command(:post, 'v1/{+name}:terminate', options)
1027
+ command.request_representation = Google::Apis::DataprocV1::TerminateSessionRequest::Representation
1028
+ command.request_object = terminate_session_request_object
1029
+ command.response_representation = Google::Apis::DataprocV1::Operation::Representation
1030
+ command.response_class = Google::Apis::DataprocV1::Operation
1031
+ command.params['name'] = name unless name.nil?
1032
+ command.query['fields'] = fields unless fields.nil?
1033
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1034
+ execute_or_queue_command(command, &block)
1035
+ end
1036
+
668
1037
  # Creates new workflow template.
669
1038
  # @param [String] parent
670
1039
  # Required. The resource name of the region or location, as described in https://
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dataproc_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.52.0
4
+ version: 0.54.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-08-20 00:00:00.000000000 Z
11
+ date: 2023-09-10 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-dataproc_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dataproc_v1/v0.52.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dataproc_v1/v0.54.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dataproc_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.4.2
78
+ rubygems_version: 3.4.19
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Dataproc API V1