google-cloud-ai_platform-v1 0.18.0 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +733 -0
  3. data/lib/google/cloud/ai_platform/v1/job_service/credentials.rb +2 -1
  4. data/lib/google/cloud/ai_platform/v1/job_service/paths.rb +40 -0
  5. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +123 -0
  6. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  7. data/lib/google/cloud/aiplatform/v1/index_endpoint_pb.rb +2 -0
  8. data/lib/google/cloud/aiplatform/v1/job_service_pb.rb +46 -0
  9. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +26 -0
  10. data/lib/google/cloud/aiplatform/v1/model_pb.rb +5 -0
  11. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +20 -0
  12. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +7 -0
  13. data/lib/google/cloud/aiplatform/v1/nas_job_pb.rb +123 -0
  14. data/lib/google/cloud/aiplatform/v1/pipeline_job_pb.rb +1 -0
  15. data/lib/google/cloud/aiplatform/v1/service_networking_pb.rb +25 -0
  16. data/lib/google/cloud/aiplatform/v1/study_pb.rb +6 -0
  17. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +3 -1
  18. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +10 -3
  19. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +166 -0
  20. data/proto_docs/google/cloud/aiplatform/v1/model.rb +15 -0
  21. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +58 -0
  22. data/proto_docs/google/cloud/aiplatform/v1/nas_job.rb +306 -0
  23. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +5 -0
  24. data/proto_docs/google/cloud/aiplatform/v1/service_networking.rb +39 -0
  25. data/proto_docs/google/cloud/aiplatform/v1/study.rb +22 -0
  26. metadata +6 -2
@@ -1661,6 +1661,690 @@ module Google
1661
1661
  raise ::Google::Cloud::Error.from_error(e)
1662
1662
  end
1663
1663
 
1664
+ ##
1665
+ # Creates a NasJob
1666
+ #
1667
+ # @overload create_nas_job(request, options = nil)
1668
+ # Pass arguments to `create_nas_job` via a request object, either of type
1669
+ # {::Google::Cloud::AIPlatform::V1::CreateNasJobRequest} or an equivalent Hash.
1670
+ #
1671
+ # @param request [::Google::Cloud::AIPlatform::V1::CreateNasJobRequest, ::Hash]
1672
+ # A request object representing the call parameters. Required. To specify no
1673
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1674
+ # @param options [::Gapic::CallOptions, ::Hash]
1675
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1676
+ #
1677
+ # @overload create_nas_job(parent: nil, nas_job: nil)
1678
+ # Pass arguments to `create_nas_job` via keyword arguments. Note that at
1679
+ # least one keyword argument is required. To specify no parameters, or to keep all
1680
+ # the default parameter values, pass an empty Hash as a request object (see above).
1681
+ #
1682
+ # @param parent [::String]
1683
+ # Required. The resource name of the Location to create the NasJob in.
1684
+ # Format: `projects/{project}/locations/{location}`
1685
+ # @param nas_job [::Google::Cloud::AIPlatform::V1::NasJob, ::Hash]
1686
+ # Required. The NasJob to create.
1687
+ #
1688
+ # @yield [response, operation] Access the result along with the RPC operation
1689
+ # @yieldparam response [::Google::Cloud::AIPlatform::V1::NasJob]
1690
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1691
+ #
1692
+ # @return [::Google::Cloud::AIPlatform::V1::NasJob]
1693
+ #
1694
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1695
+ #
1696
+ # @example Basic example
1697
+ # require "google/cloud/ai_platform/v1"
1698
+ #
1699
+ # # Create a client object. The client can be reused for multiple calls.
1700
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
1701
+ #
1702
+ # # Create a request. To set request fields, pass in keyword arguments.
1703
+ # request = Google::Cloud::AIPlatform::V1::CreateNasJobRequest.new
1704
+ #
1705
+ # # Call the create_nas_job method.
1706
+ # result = client.create_nas_job request
1707
+ #
1708
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::NasJob.
1709
+ # p result
1710
+ #
1711
+ def create_nas_job request, options = nil
1712
+ raise ::ArgumentError, "request must be provided" if request.nil?
1713
+
1714
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateNasJobRequest
1715
+
1716
+ # Converts hash and nil to an options object
1717
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1718
+
1719
+ # Customize the options with defaults
1720
+ metadata = @config.rpcs.create_nas_job.metadata.to_h
1721
+
1722
+ # Set x-goog-api-client and x-goog-user-project headers
1723
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1724
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1725
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
1726
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1727
+
1728
+ header_params = {}
1729
+ if request.parent
1730
+ header_params["parent"] = request.parent
1731
+ end
1732
+
1733
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1734
+ metadata[:"x-goog-request-params"] ||= request_params_header
1735
+
1736
+ options.apply_defaults timeout: @config.rpcs.create_nas_job.timeout,
1737
+ metadata: metadata,
1738
+ retry_policy: @config.rpcs.create_nas_job.retry_policy
1739
+
1740
+ options.apply_defaults timeout: @config.timeout,
1741
+ metadata: @config.metadata,
1742
+ retry_policy: @config.retry_policy
1743
+
1744
+ @job_service_stub.call_rpc :create_nas_job, request, options: options do |response, operation|
1745
+ yield response, operation if block_given?
1746
+ return response
1747
+ end
1748
+ rescue ::GRPC::BadStatus => e
1749
+ raise ::Google::Cloud::Error.from_error(e)
1750
+ end
1751
+
1752
+ ##
1753
+ # Gets a NasJob
1754
+ #
1755
+ # @overload get_nas_job(request, options = nil)
1756
+ # Pass arguments to `get_nas_job` via a request object, either of type
1757
+ # {::Google::Cloud::AIPlatform::V1::GetNasJobRequest} or an equivalent Hash.
1758
+ #
1759
+ # @param request [::Google::Cloud::AIPlatform::V1::GetNasJobRequest, ::Hash]
1760
+ # A request object representing the call parameters. Required. To specify no
1761
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1762
+ # @param options [::Gapic::CallOptions, ::Hash]
1763
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1764
+ #
1765
+ # @overload get_nas_job(name: nil)
1766
+ # Pass arguments to `get_nas_job` via keyword arguments. Note that at
1767
+ # least one keyword argument is required. To specify no parameters, or to keep all
1768
+ # the default parameter values, pass an empty Hash as a request object (see above).
1769
+ #
1770
+ # @param name [::String]
1771
+ # Required. The name of the NasJob resource.
1772
+ # Format:
1773
+ # `projects/{project}/locations/{location}/nasJobs/{nas_job}`
1774
+ #
1775
+ # @yield [response, operation] Access the result along with the RPC operation
1776
+ # @yieldparam response [::Google::Cloud::AIPlatform::V1::NasJob]
1777
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1778
+ #
1779
+ # @return [::Google::Cloud::AIPlatform::V1::NasJob]
1780
+ #
1781
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1782
+ #
1783
+ # @example Basic example
1784
+ # require "google/cloud/ai_platform/v1"
1785
+ #
1786
+ # # Create a client object. The client can be reused for multiple calls.
1787
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
1788
+ #
1789
+ # # Create a request. To set request fields, pass in keyword arguments.
1790
+ # request = Google::Cloud::AIPlatform::V1::GetNasJobRequest.new
1791
+ #
1792
+ # # Call the get_nas_job method.
1793
+ # result = client.get_nas_job request
1794
+ #
1795
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::NasJob.
1796
+ # p result
1797
+ #
1798
+ def get_nas_job request, options = nil
1799
+ raise ::ArgumentError, "request must be provided" if request.nil?
1800
+
1801
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetNasJobRequest
1802
+
1803
+ # Converts hash and nil to an options object
1804
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1805
+
1806
+ # Customize the options with defaults
1807
+ metadata = @config.rpcs.get_nas_job.metadata.to_h
1808
+
1809
+ # Set x-goog-api-client and x-goog-user-project headers
1810
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1811
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1812
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
1813
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1814
+
1815
+ header_params = {}
1816
+ if request.name
1817
+ header_params["name"] = request.name
1818
+ end
1819
+
1820
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1821
+ metadata[:"x-goog-request-params"] ||= request_params_header
1822
+
1823
+ options.apply_defaults timeout: @config.rpcs.get_nas_job.timeout,
1824
+ metadata: metadata,
1825
+ retry_policy: @config.rpcs.get_nas_job.retry_policy
1826
+
1827
+ options.apply_defaults timeout: @config.timeout,
1828
+ metadata: @config.metadata,
1829
+ retry_policy: @config.retry_policy
1830
+
1831
+ @job_service_stub.call_rpc :get_nas_job, request, options: options do |response, operation|
1832
+ yield response, operation if block_given?
1833
+ return response
1834
+ end
1835
+ rescue ::GRPC::BadStatus => e
1836
+ raise ::Google::Cloud::Error.from_error(e)
1837
+ end
1838
+
1839
+ ##
1840
+ # Lists NasJobs in a Location.
1841
+ #
1842
+ # @overload list_nas_jobs(request, options = nil)
1843
+ # Pass arguments to `list_nas_jobs` via a request object, either of type
1844
+ # {::Google::Cloud::AIPlatform::V1::ListNasJobsRequest} or an equivalent Hash.
1845
+ #
1846
+ # @param request [::Google::Cloud::AIPlatform::V1::ListNasJobsRequest, ::Hash]
1847
+ # A request object representing the call parameters. Required. To specify no
1848
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1849
+ # @param options [::Gapic::CallOptions, ::Hash]
1850
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1851
+ #
1852
+ # @overload list_nas_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil)
1853
+ # Pass arguments to `list_nas_jobs` via keyword arguments. Note that at
1854
+ # least one keyword argument is required. To specify no parameters, or to keep all
1855
+ # the default parameter values, pass an empty Hash as a request object (see above).
1856
+ #
1857
+ # @param parent [::String]
1858
+ # Required. The resource name of the Location to list the NasJobs
1859
+ # from. Format: `projects/{project}/locations/{location}`
1860
+ # @param filter [::String]
1861
+ # The standard list filter.
1862
+ #
1863
+ # Supported fields:
1864
+ #
1865
+ # * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
1866
+ # * `state` supports `=`, `!=` comparisons.
1867
+ # * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
1868
+ # `create_time` must be in RFC 3339 format.
1869
+ # * `labels` supports general map functions that is:
1870
+ # `labels.key=value` - key:value equality
1871
+ # `labels.key:* - key existence
1872
+ #
1873
+ # Some examples of using the filter are:
1874
+ #
1875
+ # * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
1876
+ # * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
1877
+ # * `NOT display_name="my_job"`
1878
+ # * `create_time>"2021-05-18T00:00:00Z"`
1879
+ # * `labels.keyA=valueA`
1880
+ # * `labels.keyB:*`
1881
+ # @param page_size [::Integer]
1882
+ # The standard list page size.
1883
+ # @param page_token [::String]
1884
+ # The standard list page token.
1885
+ # Typically obtained via
1886
+ # {::Google::Cloud::AIPlatform::V1::ListNasJobsResponse#next_page_token ListNasJobsResponse.next_page_token}
1887
+ # of the previous
1888
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_jobs JobService.ListNasJobs}
1889
+ # call.
1890
+ # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1891
+ # Mask specifying which fields to read.
1892
+ #
1893
+ # @yield [response, operation] Access the result along with the RPC operation
1894
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>]
1895
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1896
+ #
1897
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasJob>]
1898
+ #
1899
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1900
+ #
1901
+ # @example Basic example
1902
+ # require "google/cloud/ai_platform/v1"
1903
+ #
1904
+ # # Create a client object. The client can be reused for multiple calls.
1905
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
1906
+ #
1907
+ # # Create a request. To set request fields, pass in keyword arguments.
1908
+ # request = Google::Cloud::AIPlatform::V1::ListNasJobsRequest.new
1909
+ #
1910
+ # # Call the list_nas_jobs method.
1911
+ # result = client.list_nas_jobs request
1912
+ #
1913
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1914
+ # # iterate over all elements by calling #each, and the enumerable
1915
+ # # will lazily make API calls to fetch subsequent pages. Other
1916
+ # # methods are also available for managing paging directly.
1917
+ # result.each do |response|
1918
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::NasJob.
1919
+ # p response
1920
+ # end
1921
+ #
1922
+ def list_nas_jobs request, options = nil
1923
+ raise ::ArgumentError, "request must be provided" if request.nil?
1924
+
1925
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListNasJobsRequest
1926
+
1927
+ # Converts hash and nil to an options object
1928
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1929
+
1930
+ # Customize the options with defaults
1931
+ metadata = @config.rpcs.list_nas_jobs.metadata.to_h
1932
+
1933
+ # Set x-goog-api-client and x-goog-user-project headers
1934
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1935
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1936
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
1937
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1938
+
1939
+ header_params = {}
1940
+ if request.parent
1941
+ header_params["parent"] = request.parent
1942
+ end
1943
+
1944
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1945
+ metadata[:"x-goog-request-params"] ||= request_params_header
1946
+
1947
+ options.apply_defaults timeout: @config.rpcs.list_nas_jobs.timeout,
1948
+ metadata: metadata,
1949
+ retry_policy: @config.rpcs.list_nas_jobs.retry_policy
1950
+
1951
+ options.apply_defaults timeout: @config.timeout,
1952
+ metadata: @config.metadata,
1953
+ retry_policy: @config.retry_policy
1954
+
1955
+ @job_service_stub.call_rpc :list_nas_jobs, request, options: options do |response, operation|
1956
+ response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_nas_jobs, request, response, operation, options
1957
+ yield response, operation if block_given?
1958
+ return response
1959
+ end
1960
+ rescue ::GRPC::BadStatus => e
1961
+ raise ::Google::Cloud::Error.from_error(e)
1962
+ end
1963
+
1964
+ ##
1965
+ # Deletes a NasJob.
1966
+ #
1967
+ # @overload delete_nas_job(request, options = nil)
1968
+ # Pass arguments to `delete_nas_job` via a request object, either of type
1969
+ # {::Google::Cloud::AIPlatform::V1::DeleteNasJobRequest} or an equivalent Hash.
1970
+ #
1971
+ # @param request [::Google::Cloud::AIPlatform::V1::DeleteNasJobRequest, ::Hash]
1972
+ # A request object representing the call parameters. Required. To specify no
1973
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1974
+ # @param options [::Gapic::CallOptions, ::Hash]
1975
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1976
+ #
1977
+ # @overload delete_nas_job(name: nil)
1978
+ # Pass arguments to `delete_nas_job` via keyword arguments. Note that at
1979
+ # least one keyword argument is required. To specify no parameters, or to keep all
1980
+ # the default parameter values, pass an empty Hash as a request object (see above).
1981
+ #
1982
+ # @param name [::String]
1983
+ # Required. The name of the NasJob resource to be deleted.
1984
+ # Format:
1985
+ # `projects/{project}/locations/{location}/nasJobs/{nas_job}`
1986
+ #
1987
+ # @yield [response, operation] Access the result along with the RPC operation
1988
+ # @yieldparam response [::Gapic::Operation]
1989
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1990
+ #
1991
+ # @return [::Gapic::Operation]
1992
+ #
1993
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1994
+ #
1995
+ # @example Basic example
1996
+ # require "google/cloud/ai_platform/v1"
1997
+ #
1998
+ # # Create a client object. The client can be reused for multiple calls.
1999
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
2000
+ #
2001
+ # # Create a request. To set request fields, pass in keyword arguments.
2002
+ # request = Google::Cloud::AIPlatform::V1::DeleteNasJobRequest.new
2003
+ #
2004
+ # # Call the delete_nas_job method.
2005
+ # result = client.delete_nas_job request
2006
+ #
2007
+ # # The returned object is of type Gapic::Operation. You can use this
2008
+ # # object to check the status of an operation, cancel it, or wait
2009
+ # # for results. Here is how to block until completion:
2010
+ # result.wait_until_done! timeout: 60
2011
+ # if result.response?
2012
+ # p result.response
2013
+ # else
2014
+ # puts "Error!"
2015
+ # end
2016
+ #
2017
+ def delete_nas_job request, options = nil
2018
+ raise ::ArgumentError, "request must be provided" if request.nil?
2019
+
2020
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteNasJobRequest
2021
+
2022
+ # Converts hash and nil to an options object
2023
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2024
+
2025
+ # Customize the options with defaults
2026
+ metadata = @config.rpcs.delete_nas_job.metadata.to_h
2027
+
2028
+ # Set x-goog-api-client and x-goog-user-project headers
2029
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2030
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2031
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
2032
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2033
+
2034
+ header_params = {}
2035
+ if request.name
2036
+ header_params["name"] = request.name
2037
+ end
2038
+
2039
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2040
+ metadata[:"x-goog-request-params"] ||= request_params_header
2041
+
2042
+ options.apply_defaults timeout: @config.rpcs.delete_nas_job.timeout,
2043
+ metadata: metadata,
2044
+ retry_policy: @config.rpcs.delete_nas_job.retry_policy
2045
+
2046
+ options.apply_defaults timeout: @config.timeout,
2047
+ metadata: @config.metadata,
2048
+ retry_policy: @config.retry_policy
2049
+
2050
+ @job_service_stub.call_rpc :delete_nas_job, request, options: options do |response, operation|
2051
+ response = ::Gapic::Operation.new response, @operations_client, options: options
2052
+ yield response, operation if block_given?
2053
+ return response
2054
+ end
2055
+ rescue ::GRPC::BadStatus => e
2056
+ raise ::Google::Cloud::Error.from_error(e)
2057
+ end
2058
+
2059
+ ##
2060
+ # Cancels a NasJob.
2061
+ # Starts asynchronous cancellation on the NasJob. The server
2062
+ # makes a best effort to cancel the job, but success is not
2063
+ # guaranteed. Clients can use
2064
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#get_nas_job JobService.GetNasJob} or
2065
+ # other methods to check whether the cancellation succeeded or whether the
2066
+ # job completed despite cancellation. On successful cancellation,
2067
+ # the NasJob is not deleted; instead it becomes a job with
2068
+ # a {::Google::Cloud::AIPlatform::V1::NasJob#error NasJob.error} value with a
2069
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
2070
+ # `Code.CANCELLED`, and
2071
+ # {::Google::Cloud::AIPlatform::V1::NasJob#state NasJob.state} is set to
2072
+ # `CANCELLED`.
2073
+ #
2074
+ # @overload cancel_nas_job(request, options = nil)
2075
+ # Pass arguments to `cancel_nas_job` via a request object, either of type
2076
+ # {::Google::Cloud::AIPlatform::V1::CancelNasJobRequest} or an equivalent Hash.
2077
+ #
2078
+ # @param request [::Google::Cloud::AIPlatform::V1::CancelNasJobRequest, ::Hash]
2079
+ # A request object representing the call parameters. Required. To specify no
2080
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2081
+ # @param options [::Gapic::CallOptions, ::Hash]
2082
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2083
+ #
2084
+ # @overload cancel_nas_job(name: nil)
2085
+ # Pass arguments to `cancel_nas_job` via keyword arguments. Note that at
2086
+ # least one keyword argument is required. To specify no parameters, or to keep all
2087
+ # the default parameter values, pass an empty Hash as a request object (see above).
2088
+ #
2089
+ # @param name [::String]
2090
+ # Required. The name of the NasJob to cancel.
2091
+ # Format:
2092
+ # `projects/{project}/locations/{location}/nasJobs/{nas_job}`
2093
+ #
2094
+ # @yield [response, operation] Access the result along with the RPC operation
2095
+ # @yieldparam response [::Google::Protobuf::Empty]
2096
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2097
+ #
2098
+ # @return [::Google::Protobuf::Empty]
2099
+ #
2100
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2101
+ #
2102
+ # @example Basic example
2103
+ # require "google/cloud/ai_platform/v1"
2104
+ #
2105
+ # # Create a client object. The client can be reused for multiple calls.
2106
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
2107
+ #
2108
+ # # Create a request. To set request fields, pass in keyword arguments.
2109
+ # request = Google::Cloud::AIPlatform::V1::CancelNasJobRequest.new
2110
+ #
2111
+ # # Call the cancel_nas_job method.
2112
+ # result = client.cancel_nas_job request
2113
+ #
2114
+ # # The returned object is of type Google::Protobuf::Empty.
2115
+ # p result
2116
+ #
2117
+ def cancel_nas_job request, options = nil
2118
+ raise ::ArgumentError, "request must be provided" if request.nil?
2119
+
2120
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelNasJobRequest
2121
+
2122
+ # Converts hash and nil to an options object
2123
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2124
+
2125
+ # Customize the options with defaults
2126
+ metadata = @config.rpcs.cancel_nas_job.metadata.to_h
2127
+
2128
+ # Set x-goog-api-client and x-goog-user-project headers
2129
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2130
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2131
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
2132
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2133
+
2134
+ header_params = {}
2135
+ if request.name
2136
+ header_params["name"] = request.name
2137
+ end
2138
+
2139
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2140
+ metadata[:"x-goog-request-params"] ||= request_params_header
2141
+
2142
+ options.apply_defaults timeout: @config.rpcs.cancel_nas_job.timeout,
2143
+ metadata: metadata,
2144
+ retry_policy: @config.rpcs.cancel_nas_job.retry_policy
2145
+
2146
+ options.apply_defaults timeout: @config.timeout,
2147
+ metadata: @config.metadata,
2148
+ retry_policy: @config.retry_policy
2149
+
2150
+ @job_service_stub.call_rpc :cancel_nas_job, request, options: options do |response, operation|
2151
+ yield response, operation if block_given?
2152
+ return response
2153
+ end
2154
+ rescue ::GRPC::BadStatus => e
2155
+ raise ::Google::Cloud::Error.from_error(e)
2156
+ end
2157
+
2158
+ ##
2159
+ # Gets a NasTrialDetail.
2160
+ #
2161
+ # @overload get_nas_trial_detail(request, options = nil)
2162
+ # Pass arguments to `get_nas_trial_detail` via a request object, either of type
2163
+ # {::Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest} or an equivalent Hash.
2164
+ #
2165
+ # @param request [::Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest, ::Hash]
2166
+ # A request object representing the call parameters. Required. To specify no
2167
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2168
+ # @param options [::Gapic::CallOptions, ::Hash]
2169
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2170
+ #
2171
+ # @overload get_nas_trial_detail(name: nil)
2172
+ # Pass arguments to `get_nas_trial_detail` via keyword arguments. Note that at
2173
+ # least one keyword argument is required. To specify no parameters, or to keep all
2174
+ # the default parameter values, pass an empty Hash as a request object (see above).
2175
+ #
2176
+ # @param name [::String]
2177
+ # Required. The name of the NasTrialDetail resource.
2178
+ # Format:
2179
+ # `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
2180
+ #
2181
+ # @yield [response, operation] Access the result along with the RPC operation
2182
+ # @yieldparam response [::Google::Cloud::AIPlatform::V1::NasTrialDetail]
2183
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2184
+ #
2185
+ # @return [::Google::Cloud::AIPlatform::V1::NasTrialDetail]
2186
+ #
2187
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2188
+ #
2189
+ # @example Basic example
2190
+ # require "google/cloud/ai_platform/v1"
2191
+ #
2192
+ # # Create a client object. The client can be reused for multiple calls.
2193
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
2194
+ #
2195
+ # # Create a request. To set request fields, pass in keyword arguments.
2196
+ # request = Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest.new
2197
+ #
2198
+ # # Call the get_nas_trial_detail method.
2199
+ # result = client.get_nas_trial_detail request
2200
+ #
2201
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::NasTrialDetail.
2202
+ # p result
2203
+ #
2204
+ def get_nas_trial_detail request, options = nil
2205
+ raise ::ArgumentError, "request must be provided" if request.nil?
2206
+
2207
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetNasTrialDetailRequest
2208
+
2209
+ # Converts hash and nil to an options object
2210
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2211
+
2212
+ # Customize the options with defaults
2213
+ metadata = @config.rpcs.get_nas_trial_detail.metadata.to_h
2214
+
2215
+ # Set x-goog-api-client and x-goog-user-project headers
2216
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2217
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2218
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
2219
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2220
+
2221
+ header_params = {}
2222
+ if request.name
2223
+ header_params["name"] = request.name
2224
+ end
2225
+
2226
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2227
+ metadata[:"x-goog-request-params"] ||= request_params_header
2228
+
2229
+ options.apply_defaults timeout: @config.rpcs.get_nas_trial_detail.timeout,
2230
+ metadata: metadata,
2231
+ retry_policy: @config.rpcs.get_nas_trial_detail.retry_policy
2232
+
2233
+ options.apply_defaults timeout: @config.timeout,
2234
+ metadata: @config.metadata,
2235
+ retry_policy: @config.retry_policy
2236
+
2237
+ @job_service_stub.call_rpc :get_nas_trial_detail, request, options: options do |response, operation|
2238
+ yield response, operation if block_given?
2239
+ return response
2240
+ end
2241
+ rescue ::GRPC::BadStatus => e
2242
+ raise ::Google::Cloud::Error.from_error(e)
2243
+ end
2244
+
2245
+ ##
2246
+ # List top NasTrialDetails of a NasJob.
2247
+ #
2248
+ # @overload list_nas_trial_details(request, options = nil)
2249
+ # Pass arguments to `list_nas_trial_details` via a request object, either of type
2250
+ # {::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest} or an equivalent Hash.
2251
+ #
2252
+ # @param request [::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest, ::Hash]
2253
+ # A request object representing the call parameters. Required. To specify no
2254
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2255
+ # @param options [::Gapic::CallOptions, ::Hash]
2256
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2257
+ #
2258
+ # @overload list_nas_trial_details(parent: nil, page_size: nil, page_token: nil)
2259
+ # Pass arguments to `list_nas_trial_details` via keyword arguments. Note that at
2260
+ # least one keyword argument is required. To specify no parameters, or to keep all
2261
+ # the default parameter values, pass an empty Hash as a request object (see above).
2262
+ #
2263
+ # @param parent [::String]
2264
+ # Required. The name of the NasJob resource.
2265
+ # Format:
2266
+ # `projects/{project}/locations/{location}/nasJobs/{nas_job}`
2267
+ # @param page_size [::Integer]
2268
+ # The standard list page size.
2269
+ # @param page_token [::String]
2270
+ # The standard list page token.
2271
+ # Typically obtained via
2272
+ # {::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsResponse#next_page_token ListNasTrialDetailsResponse.next_page_token}
2273
+ # of the previous
2274
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_trial_details JobService.ListNasTrialDetails}
2275
+ # call.
2276
+ #
2277
+ # @yield [response, operation] Access the result along with the RPC operation
2278
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>]
2279
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2280
+ #
2281
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NasTrialDetail>]
2282
+ #
2283
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2284
+ #
2285
+ # @example Basic example
2286
+ # require "google/cloud/ai_platform/v1"
2287
+ #
2288
+ # # Create a client object. The client can be reused for multiple calls.
2289
+ # client = Google::Cloud::AIPlatform::V1::JobService::Client.new
2290
+ #
2291
+ # # Create a request. To set request fields, pass in keyword arguments.
2292
+ # request = Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest.new
2293
+ #
2294
+ # # Call the list_nas_trial_details method.
2295
+ # result = client.list_nas_trial_details request
2296
+ #
2297
+ # # The returned object is of type Gapic::PagedEnumerable. You can
2298
+ # # iterate over all elements by calling #each, and the enumerable
2299
+ # # will lazily make API calls to fetch subsequent pages. Other
2300
+ # # methods are also available for managing paging directly.
2301
+ # result.each do |response|
2302
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::NasTrialDetail.
2303
+ # p response
2304
+ # end
2305
+ #
2306
+ def list_nas_trial_details request, options = nil
2307
+ raise ::ArgumentError, "request must be provided" if request.nil?
2308
+
2309
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest
2310
+
2311
+ # Converts hash and nil to an options object
2312
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2313
+
2314
+ # Customize the options with defaults
2315
+ metadata = @config.rpcs.list_nas_trial_details.metadata.to_h
2316
+
2317
+ # Set x-goog-api-client and x-goog-user-project headers
2318
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2319
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2320
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
2321
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2322
+
2323
+ header_params = {}
2324
+ if request.parent
2325
+ header_params["parent"] = request.parent
2326
+ end
2327
+
2328
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2329
+ metadata[:"x-goog-request-params"] ||= request_params_header
2330
+
2331
+ options.apply_defaults timeout: @config.rpcs.list_nas_trial_details.timeout,
2332
+ metadata: metadata,
2333
+ retry_policy: @config.rpcs.list_nas_trial_details.retry_policy
2334
+
2335
+ options.apply_defaults timeout: @config.timeout,
2336
+ metadata: @config.metadata,
2337
+ retry_policy: @config.retry_policy
2338
+
2339
+ @job_service_stub.call_rpc :list_nas_trial_details, request, options: options do |response, operation|
2340
+ response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_nas_trial_details, request, response, operation, options
2341
+ yield response, operation if block_given?
2342
+ return response
2343
+ end
2344
+ rescue ::GRPC::BadStatus => e
2345
+ raise ::Google::Cloud::Error.from_error(e)
2346
+ end
2347
+
1664
2348
  ##
1665
2349
  # Creates a BatchPredictionJob. A BatchPredictionJob once created will
1666
2350
  # right away be attempted to start.
@@ -3175,6 +3859,41 @@ module Google
3175
3859
  #
3176
3860
  attr_reader :cancel_hyperparameter_tuning_job
3177
3861
  ##
3862
+ # RPC-specific configuration for `create_nas_job`
3863
+ # @return [::Gapic::Config::Method]
3864
+ #
3865
+ attr_reader :create_nas_job
3866
+ ##
3867
+ # RPC-specific configuration for `get_nas_job`
3868
+ # @return [::Gapic::Config::Method]
3869
+ #
3870
+ attr_reader :get_nas_job
3871
+ ##
3872
+ # RPC-specific configuration for `list_nas_jobs`
3873
+ # @return [::Gapic::Config::Method]
3874
+ #
3875
+ attr_reader :list_nas_jobs
3876
+ ##
3877
+ # RPC-specific configuration for `delete_nas_job`
3878
+ # @return [::Gapic::Config::Method]
3879
+ #
3880
+ attr_reader :delete_nas_job
3881
+ ##
3882
+ # RPC-specific configuration for `cancel_nas_job`
3883
+ # @return [::Gapic::Config::Method]
3884
+ #
3885
+ attr_reader :cancel_nas_job
3886
+ ##
3887
+ # RPC-specific configuration for `get_nas_trial_detail`
3888
+ # @return [::Gapic::Config::Method]
3889
+ #
3890
+ attr_reader :get_nas_trial_detail
3891
+ ##
3892
+ # RPC-specific configuration for `list_nas_trial_details`
3893
+ # @return [::Gapic::Config::Method]
3894
+ #
3895
+ attr_reader :list_nas_trial_details
3896
+ ##
3178
3897
  # RPC-specific configuration for `create_batch_prediction_job`
3179
3898
  # @return [::Gapic::Config::Method]
3180
3899
  #
@@ -3272,6 +3991,20 @@ module Google
3272
3991
  @delete_hyperparameter_tuning_job = ::Gapic::Config::Method.new delete_hyperparameter_tuning_job_config
3273
3992
  cancel_hyperparameter_tuning_job_config = parent_rpcs.cancel_hyperparameter_tuning_job if parent_rpcs.respond_to? :cancel_hyperparameter_tuning_job
3274
3993
  @cancel_hyperparameter_tuning_job = ::Gapic::Config::Method.new cancel_hyperparameter_tuning_job_config
3994
+ create_nas_job_config = parent_rpcs.create_nas_job if parent_rpcs.respond_to? :create_nas_job
3995
+ @create_nas_job = ::Gapic::Config::Method.new create_nas_job_config
3996
+ get_nas_job_config = parent_rpcs.get_nas_job if parent_rpcs.respond_to? :get_nas_job
3997
+ @get_nas_job = ::Gapic::Config::Method.new get_nas_job_config
3998
+ list_nas_jobs_config = parent_rpcs.list_nas_jobs if parent_rpcs.respond_to? :list_nas_jobs
3999
+ @list_nas_jobs = ::Gapic::Config::Method.new list_nas_jobs_config
4000
+ delete_nas_job_config = parent_rpcs.delete_nas_job if parent_rpcs.respond_to? :delete_nas_job
4001
+ @delete_nas_job = ::Gapic::Config::Method.new delete_nas_job_config
4002
+ cancel_nas_job_config = parent_rpcs.cancel_nas_job if parent_rpcs.respond_to? :cancel_nas_job
4003
+ @cancel_nas_job = ::Gapic::Config::Method.new cancel_nas_job_config
4004
+ get_nas_trial_detail_config = parent_rpcs.get_nas_trial_detail if parent_rpcs.respond_to? :get_nas_trial_detail
4005
+ @get_nas_trial_detail = ::Gapic::Config::Method.new get_nas_trial_detail_config
4006
+ list_nas_trial_details_config = parent_rpcs.list_nas_trial_details if parent_rpcs.respond_to? :list_nas_trial_details
4007
+ @list_nas_trial_details = ::Gapic::Config::Method.new list_nas_trial_details_config
3275
4008
  create_batch_prediction_job_config = parent_rpcs.create_batch_prediction_job if parent_rpcs.respond_to? :create_batch_prediction_job
3276
4009
  @create_batch_prediction_job = ::Gapic::Config::Method.new create_batch_prediction_job_config
3277
4010
  get_batch_prediction_job_config = parent_rpcs.get_batch_prediction_job if parent_rpcs.respond_to? :get_batch_prediction_job