class Google::Cloud::Lustre::V1::Lustre::Rest::Client
Service describing handlers for resources
REST client for the Lustre service.
#
def self.configure
-
(Client::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Lustre", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end
def configure
-
(Client::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def configure yield @config if block_given? @config end
def create_instance request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
request_id
(::String
) -- -
instance
(::Google::Cloud::Lustre::V1::Instance, ::Hash
) -- -
instance_id
(::String
) -- -
parent
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::CreateInstanceRequest, ::Hash
) --
Overloads:
-
create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil)
-
create_instance(request, options = nil)
def create_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::CreateInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.create_instance.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.create_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.create_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def delete_instance request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
request_id
(::String
) -- -
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::DeleteInstanceRequest, ::Hash
) --
Overloads:
-
delete_instance(name: nil, request_id: nil)
-
delete_instance(request, options = nil)
def delete_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::DeleteInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete_instance.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.delete_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def export_data request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
service_account
(::String
) -- -
request_id
(::String
) -- -
name
(::String
) -- -
gcs_path
(::Google::Cloud::Lustre::V1::GcsPath, ::Hash
) -- -
lustre_path
(::Google::Cloud::Lustre::V1::LustrePath, ::Hash
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::ExportDataRequest, ::Hash
) --
Overloads:
-
export_data(lustre_path: nil, gcs_path: nil, name: nil, request_id: nil, service_account: nil)
-
export_data(request, options = nil)
def export_data request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::ExportDataRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.export_data.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.export_data.timeout, metadata: call_metadata, retry_policy: @config.rpcs.export_data.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.export_data request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def get_instance request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Google::Cloud::Lustre::V1::Instance)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::GetInstanceRequest, ::Hash
) --
Overloads:
-
get_instance(name: nil)
-
get_instance(request, options = nil)
def get_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::GetInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_instance.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.get_instance request, options do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def import_data request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
service_account
(::String
) -- -
request_id
(::String
) -- -
name
(::String
) -- -
lustre_path
(::Google::Cloud::Lustre::V1::LustrePath, ::Hash
) -- -
gcs_path
(::Google::Cloud::Lustre::V1::GcsPath, ::Hash
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::ImportDataRequest, ::Hash
) --
Overloads:
-
import_data(gcs_path: nil, lustre_path: nil, name: nil, request_id: nil, service_account: nil)
-
import_data(request, options = nil)
def import_data request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::ImportDataRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.import_data.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.import_data.timeout, metadata: call_metadata, retry_policy: @config.rpcs.import_data.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.import_data request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def initialize
- Yieldparam: config -
Other tags:
- Yield: - Configure the Lustre client.
def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::Lustre::V1::Lustre::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @lustre_stub = ::Google::Cloud::Lustre::V1::Lustre::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials, logger: @config.logger ) @lustre_stub.logger(stub: true)&.info do |entry| entry.set_system_name entry.set_service entry.message = "Created client for #{entry.service}" entry.set_credentials_fields credentials entry.set "customEndpoint", @config.endpoint if @config.endpoint entry.set "defaultTimeout", @config.timeout if @config.timeout entry.set "quotaProject", @quota_project_id if @quota_project_id end @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @lustre_stub.endpoint config.universe_domain = @lustre_stub.universe_domain config.bindings_override = @config.bindings_override config.logger = @lustre_stub.logger if config.respond_to? :logger= end end
def list_instances request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Lustre::V1::Instance>)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
order_by
(::String
) -- -
filter
(::String
) -- -
page_token
(::String
) -- -
page_size
(::Integer
) -- -
parent
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::ListInstancesRequest, ::Hash
) --
Overloads:
-
list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
-
list_instances(request, options = nil)
def list_instances request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::ListInstancesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_instances.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_instances.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_instances.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.list_instances request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @lustre_stub, :list_instances, "instances", request, result, options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def logger
-
(Logger)
-
def logger @lustre_stub.logger end
def universe_domain
-
(String)
-
def universe_domain @lustre_stub.universe_domain end
def update_instance request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
request_id
(::String
) -- -
instance
(::Google::Cloud::Lustre::V1::Instance, ::Hash
) -- -
update_mask
(::Google::Protobuf::FieldMask, ::Hash
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Cloud::Lustre::V1::UpdateInstanceRequest, ::Hash
) --
Overloads:
-
update_instance(update_mask: nil, instance: nil, request_id: nil)
-
update_instance(request, options = nil)
def update_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Lustre::V1::UpdateInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_instance.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @lustre_stub.update_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end