google-cloud-alloy_db-v1beta 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/client.rb +789 -113
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/paths.rb +21 -0
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/client.rb +531 -5
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/service_stub.rb +357 -0
- data/lib/google/cloud/alloy_db/v1beta/version.rb +1 -1
- data/lib/google/cloud/alloydb/v1beta/resources_pb.rb +8 -2
- data/lib/google/cloud/alloydb/v1beta/service_pb.rb +9 -1
- data/lib/google/cloud/alloydb/v1beta/service_services_pb.rb +13 -0
- data/proto_docs/google/cloud/alloydb/v1beta/resources.rb +134 -16
- data/proto_docs/google/cloud/alloydb/v1beta/service.rb +206 -3
- metadata +2 -2
@@ -113,6 +113,16 @@ module Google
|
|
113
113
|
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
114
114
|
}
|
115
115
|
|
116
|
+
default_config.rpcs.list_users.timeout = 60.0
|
117
|
+
default_config.rpcs.list_users.retry_policy = {
|
118
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
119
|
+
}
|
120
|
+
|
121
|
+
default_config.rpcs.get_user.timeout = 60.0
|
122
|
+
default_config.rpcs.get_user.retry_policy = {
|
123
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
124
|
+
}
|
125
|
+
|
116
126
|
default_config
|
117
127
|
end
|
118
128
|
yield @configure if block_given?
|
@@ -347,7 +357,7 @@ module Google
|
|
347
357
|
# @param options [::Gapic::CallOptions, ::Hash]
|
348
358
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
349
359
|
#
|
350
|
-
# @overload get_cluster(name: nil)
|
360
|
+
# @overload get_cluster(name: nil, view: nil)
|
351
361
|
# Pass arguments to `get_cluster` via keyword arguments. Note that at
|
352
362
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
353
363
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -355,6 +365,9 @@ module Google
|
|
355
365
|
# @param name [::String]
|
356
366
|
# Required. The name of the resource. For the required format, see the
|
357
367
|
# comment on the Cluster.name field.
|
368
|
+
# @param view [::Google::Cloud::AlloyDB::V1beta::ClusterView]
|
369
|
+
# Optional. The view of the cluster to return. Returns all default fields if
|
370
|
+
# not set.
|
358
371
|
#
|
359
372
|
# @yield [response, operation] Access the result along with the RPC operation
|
360
373
|
# @yieldparam response [::Google::Cloud::AlloyDB::V1beta::Cluster]
|
@@ -439,7 +452,7 @@ module Google
|
|
439
452
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
440
453
|
#
|
441
454
|
# @param parent [::String]
|
442
|
-
# Required. The
|
455
|
+
# Required. The location of the new cluster. For the required format, see the
|
443
456
|
# comment on the Cluster.name field.
|
444
457
|
# @param cluster_id [::String]
|
445
458
|
# Required. ID of the requesting object.
|
@@ -1034,8 +1047,8 @@ module Google
|
|
1034
1047
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1035
1048
|
#
|
1036
1049
|
# @param parent [::String]
|
1037
|
-
# Required. The
|
1038
|
-
#
|
1050
|
+
# Required. The location of the new cluster. For the required
|
1051
|
+
# format, see the comment on the Cluster.name field.
|
1039
1052
|
# @param cluster_id [::String]
|
1040
1053
|
# Required. ID of the requesting object (the secondary cluster).
|
1041
1054
|
# @param cluster [::Google::Cloud::AlloyDB::V1beta::Cluster, ::Hash]
|
@@ -2021,6 +2034,121 @@ module Google
|
|
2021
2034
|
raise ::Google::Cloud::Error.from_error(e)
|
2022
2035
|
end
|
2023
2036
|
|
2037
|
+
##
|
2038
|
+
# Injects fault in an instance.
|
2039
|
+
# Imperative only.
|
2040
|
+
#
|
2041
|
+
# @overload inject_fault(request, options = nil)
|
2042
|
+
# Pass arguments to `inject_fault` via a request object, either of type
|
2043
|
+
# {::Google::Cloud::AlloyDB::V1beta::InjectFaultRequest} or an equivalent Hash.
|
2044
|
+
#
|
2045
|
+
# @param request [::Google::Cloud::AlloyDB::V1beta::InjectFaultRequest, ::Hash]
|
2046
|
+
# A request object representing the call parameters. Required. To specify no
|
2047
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2048
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2049
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2050
|
+
#
|
2051
|
+
# @overload inject_fault(fault_type: nil, name: nil, request_id: nil, validate_only: nil)
|
2052
|
+
# Pass arguments to `inject_fault` via keyword arguments. Note that at
|
2053
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2054
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2055
|
+
#
|
2056
|
+
# @param fault_type [::Google::Cloud::AlloyDB::V1beta::InjectFaultRequest::FaultType]
|
2057
|
+
# Required. The type of fault to be injected in an instance.
|
2058
|
+
# @param name [::String]
|
2059
|
+
# Required. The name of the resource. For the required format, see the
|
2060
|
+
# comment on the Instance.name field.
|
2061
|
+
# @param request_id [::String]
|
2062
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
2063
|
+
# request ID so that if you must retry your request, the server will know to
|
2064
|
+
# ignore the request if it has already been completed. The server will
|
2065
|
+
# guarantee that for at least 60 minutes after the first request.
|
2066
|
+
#
|
2067
|
+
# For example, consider a situation where you make an initial request and
|
2068
|
+
# the request times out. If you make the request again with the same request
|
2069
|
+
# ID, the server can check if original operation with the same request ID
|
2070
|
+
# was received, and if so, will ignore the second request. This prevents
|
2071
|
+
# clients from accidentally creating duplicate commitments.
|
2072
|
+
#
|
2073
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
2074
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
2075
|
+
# @param validate_only [::Boolean]
|
2076
|
+
# Optional. If set, performs request validation (e.g. permission checks and
|
2077
|
+
# any other type of validation), but do not actually execute the fault
|
2078
|
+
# injection.
|
2079
|
+
#
|
2080
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
2081
|
+
# @yieldparam response [::Gapic::Operation]
|
2082
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
2083
|
+
#
|
2084
|
+
# @return [::Gapic::Operation]
|
2085
|
+
#
|
2086
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2087
|
+
#
|
2088
|
+
# @example Basic example
|
2089
|
+
# require "google/cloud/alloy_db/v1beta"
|
2090
|
+
#
|
2091
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2092
|
+
# client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
|
2093
|
+
#
|
2094
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2095
|
+
# request = Google::Cloud::AlloyDB::V1beta::InjectFaultRequest.new
|
2096
|
+
#
|
2097
|
+
# # Call the inject_fault method.
|
2098
|
+
# result = client.inject_fault request
|
2099
|
+
#
|
2100
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
2101
|
+
# # check the status of an operation, cancel it, or wait for results.
|
2102
|
+
# # Here is how to wait for a response.
|
2103
|
+
# result.wait_until_done! timeout: 60
|
2104
|
+
# if result.response?
|
2105
|
+
# p result.response
|
2106
|
+
# else
|
2107
|
+
# puts "No response received."
|
2108
|
+
# end
|
2109
|
+
#
|
2110
|
+
def inject_fault request, options = nil
|
2111
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2112
|
+
|
2113
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::InjectFaultRequest
|
2114
|
+
|
2115
|
+
# Converts hash and nil to an options object
|
2116
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2117
|
+
|
2118
|
+
# Customize the options with defaults
|
2119
|
+
metadata = @config.rpcs.inject_fault.metadata.to_h
|
2120
|
+
|
2121
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2122
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2123
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2124
|
+
gapic_version: ::Google::Cloud::AlloyDB::V1beta::VERSION
|
2125
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2126
|
+
|
2127
|
+
header_params = {}
|
2128
|
+
if request.name
|
2129
|
+
header_params["name"] = request.name
|
2130
|
+
end
|
2131
|
+
|
2132
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2133
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
2134
|
+
|
2135
|
+
options.apply_defaults timeout: @config.rpcs.inject_fault.timeout,
|
2136
|
+
metadata: metadata,
|
2137
|
+
retry_policy: @config.rpcs.inject_fault.retry_policy
|
2138
|
+
|
2139
|
+
options.apply_defaults timeout: @config.timeout,
|
2140
|
+
metadata: @config.metadata,
|
2141
|
+
retry_policy: @config.retry_policy
|
2142
|
+
|
2143
|
+
@alloy_db_admin_stub.call_rpc :inject_fault, request, options: options do |response, operation|
|
2144
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
2145
|
+
yield response, operation if block_given?
|
2146
|
+
return response
|
2147
|
+
end
|
2148
|
+
rescue ::GRPC::BadStatus => e
|
2149
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2150
|
+
end
|
2151
|
+
|
2024
2152
|
##
|
2025
2153
|
# Restart an Instance in a cluster.
|
2026
2154
|
# Imperative only.
|
@@ -2783,7 +2911,7 @@ module Google
|
|
2783
2911
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2784
2912
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2785
2913
|
#
|
2786
|
-
# @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil)
|
2914
|
+
# @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil)
|
2787
2915
|
# Pass arguments to `generate_client_certificate` via keyword arguments. Note that at
|
2788
2916
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2789
2917
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -2813,6 +2941,8 @@ module Google
|
|
2813
2941
|
# 24 hours. The endpoint may or may not honor the hint. If the hint is left
|
2814
2942
|
# unspecified or is not honored, then the endpoint will pick an appropriate
|
2815
2943
|
# default duration.
|
2944
|
+
# @param public_key [::String]
|
2945
|
+
# Optional. The public key from the client.
|
2816
2946
|
#
|
2817
2947
|
# @yield [response, operation] Access the result along with the RPC operation
|
2818
2948
|
# @yieldparam response [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
|
@@ -2979,128 +3109,632 @@ module Google
|
|
2979
3109
|
end
|
2980
3110
|
|
2981
3111
|
##
|
2982
|
-
#
|
3112
|
+
# Lists Users in a given project and location.
|
2983
3113
|
#
|
2984
|
-
#
|
2985
|
-
#
|
2986
|
-
#
|
2987
|
-
# applied individually to specific RPCs. See
|
2988
|
-
# {::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client::Configuration::Rpcs}
|
2989
|
-
# for a list of RPCs that can be configured independently.
|
3114
|
+
# @overload list_users(request, options = nil)
|
3115
|
+
# Pass arguments to `list_users` via a request object, either of type
|
3116
|
+
# {::Google::Cloud::AlloyDB::V1beta::ListUsersRequest} or an equivalent Hash.
|
2990
3117
|
#
|
2991
|
-
#
|
2992
|
-
#
|
3118
|
+
# @param request [::Google::Cloud::AlloyDB::V1beta::ListUsersRequest, ::Hash]
|
3119
|
+
# A request object representing the call parameters. Required. To specify no
|
3120
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3121
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3122
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2993
3123
|
#
|
2994
|
-
# @
|
3124
|
+
# @overload list_users(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
|
3125
|
+
# Pass arguments to `list_users` via keyword arguments. Note that at
|
3126
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3127
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2995
3128
|
#
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
2999
|
-
#
|
3000
|
-
#
|
3001
|
-
#
|
3002
|
-
#
|
3129
|
+
# @param parent [::String]
|
3130
|
+
# Required. Parent value for ListUsersRequest
|
3131
|
+
# @param page_size [::Integer]
|
3132
|
+
# Optional. Requested page size. Server may return fewer items than
|
3133
|
+
# requested. If unspecified, server will pick an appropriate default.
|
3134
|
+
# @param page_token [::String]
|
3135
|
+
# Optional. A token identifying a page of results the server should return.
|
3136
|
+
# @param filter [::String]
|
3137
|
+
# Optional. Filtering results
|
3138
|
+
# @param order_by [::String]
|
3139
|
+
# Optional. Hint for how to order the results
|
3003
3140
|
#
|
3004
|
-
#
|
3005
|
-
#
|
3006
|
-
#
|
3007
|
-
# config.rpcs.list_clusters.timeout = 20.0
|
3008
|
-
# end
|
3141
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3142
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1beta::User>]
|
3143
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3009
3144
|
#
|
3010
|
-
#
|
3011
|
-
# The hostname or hostname:port of the service endpoint.
|
3012
|
-
# Defaults to `"alloydb.googleapis.com"`.
|
3013
|
-
# @return [::String]
|
3014
|
-
# @!attribute [rw] credentials
|
3015
|
-
# Credentials to send with calls. You may provide any of the following types:
|
3016
|
-
# * (`String`) The path to a service account key file in JSON format
|
3017
|
-
# * (`Hash`) A service account key as a Hash
|
3018
|
-
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
3019
|
-
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
3020
|
-
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
3021
|
-
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
3022
|
-
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
3023
|
-
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
3024
|
-
# * (`nil`) indicating no credentials
|
3025
|
-
# @return [::Object]
|
3026
|
-
# @!attribute [rw] scope
|
3027
|
-
# The OAuth scopes
|
3028
|
-
# @return [::Array<::String>]
|
3029
|
-
# @!attribute [rw] lib_name
|
3030
|
-
# The library name as recorded in instrumentation and logging
|
3031
|
-
# @return [::String]
|
3032
|
-
# @!attribute [rw] lib_version
|
3033
|
-
# The library version as recorded in instrumentation and logging
|
3034
|
-
# @return [::String]
|
3035
|
-
# @!attribute [rw] channel_args
|
3036
|
-
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
3037
|
-
# `GRPC::Core::Channel` object is provided as the credential.
|
3038
|
-
# @return [::Hash]
|
3039
|
-
# @!attribute [rw] interceptors
|
3040
|
-
# An array of interceptors that are run before calls are executed.
|
3041
|
-
# @return [::Array<::GRPC::ClientInterceptor>]
|
3042
|
-
# @!attribute [rw] timeout
|
3043
|
-
# The call timeout in seconds.
|
3044
|
-
# @return [::Numeric]
|
3045
|
-
# @!attribute [rw] metadata
|
3046
|
-
# Additional gRPC headers to be sent with the call.
|
3047
|
-
# @return [::Hash{::Symbol=>::String}]
|
3048
|
-
# @!attribute [rw] retry_policy
|
3049
|
-
# The retry policy. The value is a hash with the following keys:
|
3050
|
-
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
3051
|
-
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
3052
|
-
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
3053
|
-
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
3054
|
-
# trigger a retry.
|
3055
|
-
# @return [::Hash]
|
3056
|
-
# @!attribute [rw] quota_project
|
3057
|
-
# A separate project against which to charge quota.
|
3058
|
-
# @return [::String]
|
3145
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1beta::User>]
|
3059
3146
|
#
|
3060
|
-
|
3061
|
-
|
3147
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3148
|
+
#
|
3149
|
+
# @example Basic example
|
3150
|
+
# require "google/cloud/alloy_db/v1beta"
|
3151
|
+
#
|
3152
|
+
# # Create a client object. The client can be reused for multiple calls.
|
3153
|
+
# client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
|
3154
|
+
#
|
3155
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
3156
|
+
# request = Google::Cloud::AlloyDB::V1beta::ListUsersRequest.new
|
3157
|
+
#
|
3158
|
+
# # Call the list_users method.
|
3159
|
+
# result = client.list_users request
|
3160
|
+
#
|
3161
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
3162
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
3163
|
+
# result.each do |item|
|
3164
|
+
# # Each element is of type ::Google::Cloud::AlloyDB::V1beta::User.
|
3165
|
+
# p item
|
3166
|
+
# end
|
3167
|
+
#
|
3168
|
+
def list_users request, options = nil
|
3169
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3062
3170
|
|
3063
|
-
|
3171
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::ListUsersRequest
|
3064
3172
|
|
3065
|
-
|
3066
|
-
|
3067
|
-
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
3068
|
-
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
3069
|
-
allowed.any? { |klass| klass === value }
|
3070
|
-
end
|
3071
|
-
config_attr :scope, nil, ::String, ::Array, nil
|
3072
|
-
config_attr :lib_name, nil, ::String, nil
|
3073
|
-
config_attr :lib_version, nil, ::String, nil
|
3074
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
3075
|
-
config_attr :interceptors, nil, ::Array, nil
|
3076
|
-
config_attr :timeout, nil, ::Numeric, nil
|
3077
|
-
config_attr :metadata, nil, ::Hash, nil
|
3078
|
-
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
3079
|
-
config_attr :quota_project, nil, ::String, nil
|
3173
|
+
# Converts hash and nil to an options object
|
3174
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3080
3175
|
|
3081
|
-
#
|
3082
|
-
|
3083
|
-
@parent_config = parent_config unless parent_config.nil?
|
3176
|
+
# Customize the options with defaults
|
3177
|
+
metadata = @config.rpcs.list_users.metadata.to_h
|
3084
3178
|
|
3085
|
-
|
3086
|
-
|
3179
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3180
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3181
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3182
|
+
gapic_version: ::Google::Cloud::AlloyDB::V1beta::VERSION
|
3183
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3087
3184
|
|
3088
|
-
|
3089
|
-
|
3090
|
-
|
3091
|
-
#
|
3092
|
-
def rpcs
|
3093
|
-
@rpcs ||= begin
|
3094
|
-
parent_rpcs = nil
|
3095
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
3096
|
-
Rpcs.new parent_rpcs
|
3097
|
-
end
|
3185
|
+
header_params = {}
|
3186
|
+
if request.parent
|
3187
|
+
header_params["parent"] = request.parent
|
3098
3188
|
end
|
3099
3189
|
|
3100
|
-
|
3101
|
-
|
3102
|
-
|
3103
|
-
|
3190
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3191
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3192
|
+
|
3193
|
+
options.apply_defaults timeout: @config.rpcs.list_users.timeout,
|
3194
|
+
metadata: metadata,
|
3195
|
+
retry_policy: @config.rpcs.list_users.retry_policy
|
3196
|
+
|
3197
|
+
options.apply_defaults timeout: @config.timeout,
|
3198
|
+
metadata: @config.metadata,
|
3199
|
+
retry_policy: @config.retry_policy
|
3200
|
+
|
3201
|
+
@alloy_db_admin_stub.call_rpc :list_users, request, options: options do |response, operation|
|
3202
|
+
response = ::Gapic::PagedEnumerable.new @alloy_db_admin_stub, :list_users, request, response, operation, options
|
3203
|
+
yield response, operation if block_given?
|
3204
|
+
return response
|
3205
|
+
end
|
3206
|
+
rescue ::GRPC::BadStatus => e
|
3207
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3208
|
+
end
|
3209
|
+
|
3210
|
+
##
|
3211
|
+
# Gets details of a single User.
|
3212
|
+
#
|
3213
|
+
# @overload get_user(request, options = nil)
|
3214
|
+
# Pass arguments to `get_user` via a request object, either of type
|
3215
|
+
# {::Google::Cloud::AlloyDB::V1beta::GetUserRequest} or an equivalent Hash.
|
3216
|
+
#
|
3217
|
+
# @param request [::Google::Cloud::AlloyDB::V1beta::GetUserRequest, ::Hash]
|
3218
|
+
# A request object representing the call parameters. Required. To specify no
|
3219
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3220
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3221
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3222
|
+
#
|
3223
|
+
# @overload get_user(name: nil)
|
3224
|
+
# Pass arguments to `get_user` via keyword arguments. Note that at
|
3225
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3226
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3227
|
+
#
|
3228
|
+
# @param name [::String]
|
3229
|
+
# Required. The name of the resource. For the required format, see the
|
3230
|
+
# comment on the User.name field.
|
3231
|
+
#
|
3232
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3233
|
+
# @yieldparam response [::Google::Cloud::AlloyDB::V1beta::User]
|
3234
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3235
|
+
#
|
3236
|
+
# @return [::Google::Cloud::AlloyDB::V1beta::User]
|
3237
|
+
#
|
3238
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3239
|
+
#
|
3240
|
+
# @example Basic example
|
3241
|
+
# require "google/cloud/alloy_db/v1beta"
|
3242
|
+
#
|
3243
|
+
# # Create a client object. The client can be reused for multiple calls.
|
3244
|
+
# client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
|
3245
|
+
#
|
3246
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
3247
|
+
# request = Google::Cloud::AlloyDB::V1beta::GetUserRequest.new
|
3248
|
+
#
|
3249
|
+
# # Call the get_user method.
|
3250
|
+
# result = client.get_user request
|
3251
|
+
#
|
3252
|
+
# # The returned object is of type Google::Cloud::AlloyDB::V1beta::User.
|
3253
|
+
# p result
|
3254
|
+
#
|
3255
|
+
def get_user request, options = nil
|
3256
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3257
|
+
|
3258
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::GetUserRequest
|
3259
|
+
|
3260
|
+
# Converts hash and nil to an options object
|
3261
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3262
|
+
|
3263
|
+
# Customize the options with defaults
|
3264
|
+
metadata = @config.rpcs.get_user.metadata.to_h
|
3265
|
+
|
3266
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3267
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3268
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3269
|
+
gapic_version: ::Google::Cloud::AlloyDB::V1beta::VERSION
|
3270
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3271
|
+
|
3272
|
+
header_params = {}
|
3273
|
+
if request.name
|
3274
|
+
header_params["name"] = request.name
|
3275
|
+
end
|
3276
|
+
|
3277
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3278
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3279
|
+
|
3280
|
+
options.apply_defaults timeout: @config.rpcs.get_user.timeout,
|
3281
|
+
metadata: metadata,
|
3282
|
+
retry_policy: @config.rpcs.get_user.retry_policy
|
3283
|
+
|
3284
|
+
options.apply_defaults timeout: @config.timeout,
|
3285
|
+
metadata: @config.metadata,
|
3286
|
+
retry_policy: @config.retry_policy
|
3287
|
+
|
3288
|
+
@alloy_db_admin_stub.call_rpc :get_user, request, options: options do |response, operation|
|
3289
|
+
yield response, operation if block_given?
|
3290
|
+
return response
|
3291
|
+
end
|
3292
|
+
rescue ::GRPC::BadStatus => e
|
3293
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3294
|
+
end
|
3295
|
+
|
3296
|
+
##
|
3297
|
+
# Creates a new User in a given project, location, and cluster.
|
3298
|
+
#
|
3299
|
+
# @overload create_user(request, options = nil)
|
3300
|
+
# Pass arguments to `create_user` via a request object, either of type
|
3301
|
+
# {::Google::Cloud::AlloyDB::V1beta::CreateUserRequest} or an equivalent Hash.
|
3302
|
+
#
|
3303
|
+
# @param request [::Google::Cloud::AlloyDB::V1beta::CreateUserRequest, ::Hash]
|
3304
|
+
# A request object representing the call parameters. Required. To specify no
|
3305
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3306
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3307
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3308
|
+
#
|
3309
|
+
# @overload create_user(parent: nil, user_id: nil, user: nil, request_id: nil, validate_only: nil)
|
3310
|
+
# Pass arguments to `create_user` via keyword arguments. Note that at
|
3311
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3312
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3313
|
+
#
|
3314
|
+
# @param parent [::String]
|
3315
|
+
# Required. Value for parent.
|
3316
|
+
# @param user_id [::String]
|
3317
|
+
# Required. ID of the requesting object.
|
3318
|
+
# @param user [::Google::Cloud::AlloyDB::V1beta::User, ::Hash]
|
3319
|
+
# Required. The resource being created
|
3320
|
+
# @param request_id [::String]
|
3321
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
3322
|
+
# request ID so that if you must retry your request, the server will know to
|
3323
|
+
# ignore the request if it has already been completed. The server will
|
3324
|
+
# guarantee that for at least 60 minutes since the first request.
|
3325
|
+
#
|
3326
|
+
# For example, consider a situation where you make an initial request and
|
3327
|
+
# the request times out. If you make the request again with the same request
|
3328
|
+
# ID, the server can check if original operation with the same request ID
|
3329
|
+
# was received, and if so, will ignore the second request. This prevents
|
3330
|
+
# clients from accidentally creating duplicate commitments.
|
3331
|
+
#
|
3332
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
3333
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
3334
|
+
# @param validate_only [::Boolean]
|
3335
|
+
# Optional. If set, the backend validates the request, but doesn't actually
|
3336
|
+
# execute it.
|
3337
|
+
#
|
3338
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3339
|
+
# @yieldparam response [::Google::Cloud::AlloyDB::V1beta::User]
|
3340
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3341
|
+
#
|
3342
|
+
# @return [::Google::Cloud::AlloyDB::V1beta::User]
|
3343
|
+
#
|
3344
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3345
|
+
#
|
3346
|
+
# @example Basic example
|
3347
|
+
# require "google/cloud/alloy_db/v1beta"
|
3348
|
+
#
|
3349
|
+
# # Create a client object. The client can be reused for multiple calls.
|
3350
|
+
# client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
|
3351
|
+
#
|
3352
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
3353
|
+
# request = Google::Cloud::AlloyDB::V1beta::CreateUserRequest.new
|
3354
|
+
#
|
3355
|
+
# # Call the create_user method.
|
3356
|
+
# result = client.create_user request
|
3357
|
+
#
|
3358
|
+
# # The returned object is of type Google::Cloud::AlloyDB::V1beta::User.
|
3359
|
+
# p result
|
3360
|
+
#
|
3361
|
+
def create_user request, options = nil
|
3362
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3363
|
+
|
3364
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::CreateUserRequest
|
3365
|
+
|
3366
|
+
# Converts hash and nil to an options object
|
3367
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3368
|
+
|
3369
|
+
# Customize the options with defaults
|
3370
|
+
metadata = @config.rpcs.create_user.metadata.to_h
|
3371
|
+
|
3372
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3373
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3374
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3375
|
+
gapic_version: ::Google::Cloud::AlloyDB::V1beta::VERSION
|
3376
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3377
|
+
|
3378
|
+
header_params = {}
|
3379
|
+
if request.parent
|
3380
|
+
header_params["parent"] = request.parent
|
3381
|
+
end
|
3382
|
+
|
3383
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3384
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3385
|
+
|
3386
|
+
options.apply_defaults timeout: @config.rpcs.create_user.timeout,
|
3387
|
+
metadata: metadata,
|
3388
|
+
retry_policy: @config.rpcs.create_user.retry_policy
|
3389
|
+
|
3390
|
+
options.apply_defaults timeout: @config.timeout,
|
3391
|
+
metadata: @config.metadata,
|
3392
|
+
retry_policy: @config.retry_policy
|
3393
|
+
|
3394
|
+
@alloy_db_admin_stub.call_rpc :create_user, request, options: options do |response, operation|
|
3395
|
+
yield response, operation if block_given?
|
3396
|
+
return response
|
3397
|
+
end
|
3398
|
+
rescue ::GRPC::BadStatus => e
|
3399
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3400
|
+
end
|
3401
|
+
|
3402
|
+
##
|
3403
|
+
# Updates the parameters of a single User.
|
3404
|
+
#
|
3405
|
+
# @overload update_user(request, options = nil)
|
3406
|
+
# Pass arguments to `update_user` via a request object, either of type
|
3407
|
+
# {::Google::Cloud::AlloyDB::V1beta::UpdateUserRequest} or an equivalent Hash.
|
3408
|
+
#
|
3409
|
+
# @param request [::Google::Cloud::AlloyDB::V1beta::UpdateUserRequest, ::Hash]
|
3410
|
+
# A request object representing the call parameters. Required. To specify no
|
3411
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3412
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3413
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3414
|
+
#
|
3415
|
+
# @overload update_user(update_mask: nil, user: nil, request_id: nil, validate_only: nil, allow_missing: nil)
|
3416
|
+
# Pass arguments to `update_user` via keyword arguments. Note that at
|
3417
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3418
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3419
|
+
#
|
3420
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
3421
|
+
# Optional. Field mask is used to specify the fields to be overwritten in the
|
3422
|
+
# User resource by the update.
|
3423
|
+
# The fields specified in the update_mask are relative to the resource, not
|
3424
|
+
# the full request. A field will be overwritten if it is in the mask. If the
|
3425
|
+
# user does not provide a mask then all fields will be overwritten.
|
3426
|
+
# @param user [::Google::Cloud::AlloyDB::V1beta::User, ::Hash]
|
3427
|
+
# Required. The resource being updated
|
3428
|
+
# @param request_id [::String]
|
3429
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
3430
|
+
# request ID so that if you must retry your request, the server will know to
|
3431
|
+
# ignore the request if it has already been completed. The server will
|
3432
|
+
# guarantee that for at least 60 minutes since the first request.
|
3433
|
+
#
|
3434
|
+
# For example, consider a situation where you make an initial request and
|
3435
|
+
# the request times out. If you make the request again with the same request
|
3436
|
+
# ID, the server can check if original operation with the same request ID
|
3437
|
+
# was received, and if so, will ignore the second request. This prevents
|
3438
|
+
# clients from accidentally creating duplicate commitments.
|
3439
|
+
#
|
3440
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
3441
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
3442
|
+
# @param validate_only [::Boolean]
|
3443
|
+
# Optional. If set, the backend validates the request, but doesn't actually
|
3444
|
+
# execute it.
|
3445
|
+
# @param allow_missing [::Boolean]
|
3446
|
+
# Optional. Allow missing fields in the update mask.
|
3447
|
+
#
|
3448
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3449
|
+
# @yieldparam response [::Google::Cloud::AlloyDB::V1beta::User]
|
3450
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3451
|
+
#
|
3452
|
+
# @return [::Google::Cloud::AlloyDB::V1beta::User]
|
3453
|
+
#
|
3454
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3455
|
+
#
|
3456
|
+
# @example Basic example
|
3457
|
+
# require "google/cloud/alloy_db/v1beta"
|
3458
|
+
#
|
3459
|
+
# # Create a client object. The client can be reused for multiple calls.
|
3460
|
+
# client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
|
3461
|
+
#
|
3462
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
3463
|
+
# request = Google::Cloud::AlloyDB::V1beta::UpdateUserRequest.new
|
3464
|
+
#
|
3465
|
+
# # Call the update_user method.
|
3466
|
+
# result = client.update_user request
|
3467
|
+
#
|
3468
|
+
# # The returned object is of type Google::Cloud::AlloyDB::V1beta::User.
|
3469
|
+
# p result
|
3470
|
+
#
|
3471
|
+
def update_user request, options = nil
|
3472
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3473
|
+
|
3474
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::UpdateUserRequest
|
3475
|
+
|
3476
|
+
# Converts hash and nil to an options object
|
3477
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3478
|
+
|
3479
|
+
# Customize the options with defaults
|
3480
|
+
metadata = @config.rpcs.update_user.metadata.to_h
|
3481
|
+
|
3482
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3483
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3484
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3485
|
+
gapic_version: ::Google::Cloud::AlloyDB::V1beta::VERSION
|
3486
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3487
|
+
|
3488
|
+
header_params = {}
|
3489
|
+
if request.user&.name
|
3490
|
+
header_params["user.name"] = request.user.name
|
3491
|
+
end
|
3492
|
+
|
3493
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3494
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3495
|
+
|
3496
|
+
options.apply_defaults timeout: @config.rpcs.update_user.timeout,
|
3497
|
+
metadata: metadata,
|
3498
|
+
retry_policy: @config.rpcs.update_user.retry_policy
|
3499
|
+
|
3500
|
+
options.apply_defaults timeout: @config.timeout,
|
3501
|
+
metadata: @config.metadata,
|
3502
|
+
retry_policy: @config.retry_policy
|
3503
|
+
|
3504
|
+
@alloy_db_admin_stub.call_rpc :update_user, request, options: options do |response, operation|
|
3505
|
+
yield response, operation if block_given?
|
3506
|
+
return response
|
3507
|
+
end
|
3508
|
+
rescue ::GRPC::BadStatus => e
|
3509
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3510
|
+
end
|
3511
|
+
|
3512
|
+
##
|
3513
|
+
# Deletes a single User.
|
3514
|
+
#
|
3515
|
+
# @overload delete_user(request, options = nil)
|
3516
|
+
# Pass arguments to `delete_user` via a request object, either of type
|
3517
|
+
# {::Google::Cloud::AlloyDB::V1beta::DeleteUserRequest} or an equivalent Hash.
|
3518
|
+
#
|
3519
|
+
# @param request [::Google::Cloud::AlloyDB::V1beta::DeleteUserRequest, ::Hash]
|
3520
|
+
# A request object representing the call parameters. Required. To specify no
|
3521
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
3522
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
3523
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3524
|
+
#
|
3525
|
+
# @overload delete_user(name: nil, request_id: nil, validate_only: nil)
|
3526
|
+
# Pass arguments to `delete_user` via keyword arguments. Note that at
|
3527
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3528
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3529
|
+
#
|
3530
|
+
# @param name [::String]
|
3531
|
+
# Required. The name of the resource. For the required format, see the
|
3532
|
+
# comment on the User.name field.
|
3533
|
+
# @param request_id [::String]
|
3534
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
3535
|
+
# request ID so that if you must retry your request, the server will know to
|
3536
|
+
# ignore the request if it has already been completed. The server will
|
3537
|
+
# guarantee that for at least 60 minutes after the first request.
|
3538
|
+
#
|
3539
|
+
# For example, consider a situation where you make an initial request and
|
3540
|
+
# the request times out. If you make the request again with the same request
|
3541
|
+
# ID, the server can check if original operation with the same request ID
|
3542
|
+
# was received, and if so, will ignore the second request. This prevents
|
3543
|
+
# clients from accidentally creating duplicate commitments.
|
3544
|
+
#
|
3545
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
3546
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
3547
|
+
# @param validate_only [::Boolean]
|
3548
|
+
# Optional. If set, the backend validates the request, but doesn't actually
|
3549
|
+
# execute it.
|
3550
|
+
#
|
3551
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3552
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
3553
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3554
|
+
#
|
3555
|
+
# @return [::Google::Protobuf::Empty]
|
3556
|
+
#
|
3557
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3558
|
+
#
|
3559
|
+
# @example Basic example
|
3560
|
+
# require "google/cloud/alloy_db/v1beta"
|
3561
|
+
#
|
3562
|
+
# # Create a client object. The client can be reused for multiple calls.
|
3563
|
+
# client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
|
3564
|
+
#
|
3565
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
3566
|
+
# request = Google::Cloud::AlloyDB::V1beta::DeleteUserRequest.new
|
3567
|
+
#
|
3568
|
+
# # Call the delete_user method.
|
3569
|
+
# result = client.delete_user request
|
3570
|
+
#
|
3571
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
3572
|
+
# p result
|
3573
|
+
#
|
3574
|
+
def delete_user request, options = nil
|
3575
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3576
|
+
|
3577
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::DeleteUserRequest
|
3578
|
+
|
3579
|
+
# Converts hash and nil to an options object
|
3580
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3581
|
+
|
3582
|
+
# Customize the options with defaults
|
3583
|
+
metadata = @config.rpcs.delete_user.metadata.to_h
|
3584
|
+
|
3585
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
3586
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3587
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3588
|
+
gapic_version: ::Google::Cloud::AlloyDB::V1beta::VERSION
|
3589
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3590
|
+
|
3591
|
+
header_params = {}
|
3592
|
+
if request.name
|
3593
|
+
header_params["name"] = request.name
|
3594
|
+
end
|
3595
|
+
|
3596
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3597
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3598
|
+
|
3599
|
+
options.apply_defaults timeout: @config.rpcs.delete_user.timeout,
|
3600
|
+
metadata: metadata,
|
3601
|
+
retry_policy: @config.rpcs.delete_user.retry_policy
|
3602
|
+
|
3603
|
+
options.apply_defaults timeout: @config.timeout,
|
3604
|
+
metadata: @config.metadata,
|
3605
|
+
retry_policy: @config.retry_policy
|
3606
|
+
|
3607
|
+
@alloy_db_admin_stub.call_rpc :delete_user, request, options: options do |response, operation|
|
3608
|
+
yield response, operation if block_given?
|
3609
|
+
return response
|
3610
|
+
end
|
3611
|
+
rescue ::GRPC::BadStatus => e
|
3612
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3613
|
+
end
|
3614
|
+
|
3615
|
+
##
|
3616
|
+
# Configuration class for the AlloyDBAdmin API.
|
3617
|
+
#
|
3618
|
+
# This class represents the configuration for AlloyDBAdmin,
|
3619
|
+
# providing control over timeouts, retry behavior, logging, transport
|
3620
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
3621
|
+
# applied individually to specific RPCs. See
|
3622
|
+
# {::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client::Configuration::Rpcs}
|
3623
|
+
# for a list of RPCs that can be configured independently.
|
3624
|
+
#
|
3625
|
+
# Configuration can be applied globally to all clients, or to a single client
|
3626
|
+
# on construction.
|
3627
|
+
#
|
3628
|
+
# @example
|
3629
|
+
#
|
3630
|
+
# # Modify the global config, setting the timeout for
|
3631
|
+
# # list_clusters to 20 seconds,
|
3632
|
+
# # and all remaining timeouts to 10 seconds.
|
3633
|
+
# ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.configure do |config|
|
3634
|
+
# config.timeout = 10.0
|
3635
|
+
# config.rpcs.list_clusters.timeout = 20.0
|
3636
|
+
# end
|
3637
|
+
#
|
3638
|
+
# # Apply the above configuration only to a new client.
|
3639
|
+
# client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new do |config|
|
3640
|
+
# config.timeout = 10.0
|
3641
|
+
# config.rpcs.list_clusters.timeout = 20.0
|
3642
|
+
# end
|
3643
|
+
#
|
3644
|
+
# @!attribute [rw] endpoint
|
3645
|
+
# The hostname or hostname:port of the service endpoint.
|
3646
|
+
# Defaults to `"alloydb.googleapis.com"`.
|
3647
|
+
# @return [::String]
|
3648
|
+
# @!attribute [rw] credentials
|
3649
|
+
# Credentials to send with calls. You may provide any of the following types:
|
3650
|
+
# * (`String`) The path to a service account key file in JSON format
|
3651
|
+
# * (`Hash`) A service account key as a Hash
|
3652
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
3653
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
3654
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
3655
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
3656
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
3657
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
3658
|
+
# * (`nil`) indicating no credentials
|
3659
|
+
# @return [::Object]
|
3660
|
+
# @!attribute [rw] scope
|
3661
|
+
# The OAuth scopes
|
3662
|
+
# @return [::Array<::String>]
|
3663
|
+
# @!attribute [rw] lib_name
|
3664
|
+
# The library name as recorded in instrumentation and logging
|
3665
|
+
# @return [::String]
|
3666
|
+
# @!attribute [rw] lib_version
|
3667
|
+
# The library version as recorded in instrumentation and logging
|
3668
|
+
# @return [::String]
|
3669
|
+
# @!attribute [rw] channel_args
|
3670
|
+
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
3671
|
+
# `GRPC::Core::Channel` object is provided as the credential.
|
3672
|
+
# @return [::Hash]
|
3673
|
+
# @!attribute [rw] interceptors
|
3674
|
+
# An array of interceptors that are run before calls are executed.
|
3675
|
+
# @return [::Array<::GRPC::ClientInterceptor>]
|
3676
|
+
# @!attribute [rw] timeout
|
3677
|
+
# The call timeout in seconds.
|
3678
|
+
# @return [::Numeric]
|
3679
|
+
# @!attribute [rw] metadata
|
3680
|
+
# Additional gRPC headers to be sent with the call.
|
3681
|
+
# @return [::Hash{::Symbol=>::String}]
|
3682
|
+
# @!attribute [rw] retry_policy
|
3683
|
+
# The retry policy. The value is a hash with the following keys:
|
3684
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
3685
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
3686
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
3687
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
3688
|
+
# trigger a retry.
|
3689
|
+
# @return [::Hash]
|
3690
|
+
# @!attribute [rw] quota_project
|
3691
|
+
# A separate project against which to charge quota.
|
3692
|
+
# @return [::String]
|
3693
|
+
#
|
3694
|
+
class Configuration
|
3695
|
+
extend ::Gapic::Config
|
3696
|
+
|
3697
|
+
DEFAULT_ENDPOINT = "alloydb.googleapis.com"
|
3698
|
+
|
3699
|
+
config_attr :endpoint, DEFAULT_ENDPOINT, ::String
|
3700
|
+
config_attr :credentials, nil do |value|
|
3701
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
3702
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
3703
|
+
allowed.any? { |klass| klass === value }
|
3704
|
+
end
|
3705
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
3706
|
+
config_attr :lib_name, nil, ::String, nil
|
3707
|
+
config_attr :lib_version, nil, ::String, nil
|
3708
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
3709
|
+
config_attr :interceptors, nil, ::Array, nil
|
3710
|
+
config_attr :timeout, nil, ::Numeric, nil
|
3711
|
+
config_attr :metadata, nil, ::Hash, nil
|
3712
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
3713
|
+
config_attr :quota_project, nil, ::String, nil
|
3714
|
+
|
3715
|
+
# @private
|
3716
|
+
def initialize parent_config = nil
|
3717
|
+
@parent_config = parent_config unless parent_config.nil?
|
3718
|
+
|
3719
|
+
yield self if block_given?
|
3720
|
+
end
|
3721
|
+
|
3722
|
+
##
|
3723
|
+
# Configurations for individual RPCs
|
3724
|
+
# @return [Rpcs]
|
3725
|
+
#
|
3726
|
+
def rpcs
|
3727
|
+
@rpcs ||= begin
|
3728
|
+
parent_rpcs = nil
|
3729
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
3730
|
+
Rpcs.new parent_rpcs
|
3731
|
+
end
|
3732
|
+
end
|
3733
|
+
|
3734
|
+
##
|
3735
|
+
# Configuration RPC class for the AlloyDBAdmin API.
|
3736
|
+
#
|
3737
|
+
# Includes fields providing the configuration for each RPC in this service.
|
3104
3738
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
3105
3739
|
# the following configuration fields:
|
3106
3740
|
#
|
@@ -3196,6 +3830,11 @@ module Google
|
|
3196
3830
|
#
|
3197
3831
|
attr_reader :failover_instance
|
3198
3832
|
##
|
3833
|
+
# RPC-specific configuration for `inject_fault`
|
3834
|
+
# @return [::Gapic::Config::Method]
|
3835
|
+
#
|
3836
|
+
attr_reader :inject_fault
|
3837
|
+
##
|
3199
3838
|
# RPC-specific configuration for `restart_instance`
|
3200
3839
|
# @return [::Gapic::Config::Method]
|
3201
3840
|
#
|
@@ -3240,6 +3879,31 @@ module Google
|
|
3240
3879
|
# @return [::Gapic::Config::Method]
|
3241
3880
|
#
|
3242
3881
|
attr_reader :get_connection_info
|
3882
|
+
##
|
3883
|
+
# RPC-specific configuration for `list_users`
|
3884
|
+
# @return [::Gapic::Config::Method]
|
3885
|
+
#
|
3886
|
+
attr_reader :list_users
|
3887
|
+
##
|
3888
|
+
# RPC-specific configuration for `get_user`
|
3889
|
+
# @return [::Gapic::Config::Method]
|
3890
|
+
#
|
3891
|
+
attr_reader :get_user
|
3892
|
+
##
|
3893
|
+
# RPC-specific configuration for `create_user`
|
3894
|
+
# @return [::Gapic::Config::Method]
|
3895
|
+
#
|
3896
|
+
attr_reader :create_user
|
3897
|
+
##
|
3898
|
+
# RPC-specific configuration for `update_user`
|
3899
|
+
# @return [::Gapic::Config::Method]
|
3900
|
+
#
|
3901
|
+
attr_reader :update_user
|
3902
|
+
##
|
3903
|
+
# RPC-specific configuration for `delete_user`
|
3904
|
+
# @return [::Gapic::Config::Method]
|
3905
|
+
#
|
3906
|
+
attr_reader :delete_user
|
3243
3907
|
|
3244
3908
|
# @private
|
3245
3909
|
def initialize parent_rpcs = nil
|
@@ -3275,6 +3939,8 @@ module Google
|
|
3275
3939
|
@delete_instance = ::Gapic::Config::Method.new delete_instance_config
|
3276
3940
|
failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
|
3277
3941
|
@failover_instance = ::Gapic::Config::Method.new failover_instance_config
|
3942
|
+
inject_fault_config = parent_rpcs.inject_fault if parent_rpcs.respond_to? :inject_fault
|
3943
|
+
@inject_fault = ::Gapic::Config::Method.new inject_fault_config
|
3278
3944
|
restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
|
3279
3945
|
@restart_instance = ::Gapic::Config::Method.new restart_instance_config
|
3280
3946
|
list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
|
@@ -3293,6 +3959,16 @@ module Google
|
|
3293
3959
|
@generate_client_certificate = ::Gapic::Config::Method.new generate_client_certificate_config
|
3294
3960
|
get_connection_info_config = parent_rpcs.get_connection_info if parent_rpcs.respond_to? :get_connection_info
|
3295
3961
|
@get_connection_info = ::Gapic::Config::Method.new get_connection_info_config
|
3962
|
+
list_users_config = parent_rpcs.list_users if parent_rpcs.respond_to? :list_users
|
3963
|
+
@list_users = ::Gapic::Config::Method.new list_users_config
|
3964
|
+
get_user_config = parent_rpcs.get_user if parent_rpcs.respond_to? :get_user
|
3965
|
+
@get_user = ::Gapic::Config::Method.new get_user_config
|
3966
|
+
create_user_config = parent_rpcs.create_user if parent_rpcs.respond_to? :create_user
|
3967
|
+
@create_user = ::Gapic::Config::Method.new create_user_config
|
3968
|
+
update_user_config = parent_rpcs.update_user if parent_rpcs.respond_to? :update_user
|
3969
|
+
@update_user = ::Gapic::Config::Method.new update_user_config
|
3970
|
+
delete_user_config = parent_rpcs.delete_user if parent_rpcs.respond_to? :delete_user
|
3971
|
+
@delete_user = ::Gapic::Config::Method.new delete_user_config
|
3296
3972
|
|
3297
3973
|
yield self if block_given?
|
3298
3974
|
end
|