Cloud FTP V1 API - Class Google::Cloud::Ftp::V1::CloudFtp::Rest::ServiceStub (v0.1.1)

Reference documentation and code samples for the Cloud FTP V1 API class Google::Cloud::Ftp::V1::CloudFtp::Rest::ServiceStub.

REST service stub for the CloudFtp service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#create_server

def create_server(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_server REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::CreateServerRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_user

def create_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_user REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::CreateUserRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_server

def delete_server(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_server REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::DeleteServerRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_user

def delete_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_user REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::DeleteUserRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_server

def get_server(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Ftp::V1::Server

Baseline implementation for the get_server REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::GetServerRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_user

def get_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Ftp::V1::User

Baseline implementation for the get_user REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::GetUserRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_servers

def list_servers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Ftp::V1::ListServersResponse

Baseline implementation for the list_servers REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::ListServersRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_users

def list_users(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Ftp::V1::ListUsersResponse

Baseline implementation for the list_users REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::ListUsersRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#start_server

def start_server(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the start_server REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::StartServerRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#stop_server

def stop_server(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the stop_server REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::StopServerRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_server

def update_server(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_server REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::UpdateServerRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_user

def update_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_user REST call

Parameters
  • request_pb (::Google::Cloud::Ftp::V1::UpdateUserRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)