Access Approval V1 API - Class Google::Cloud::AccessApproval::V1::AccessApproval::Rest::ServiceStub (v0.12.0)

Reference documentation and code samples for the Access Approval V1 API class Google::Cloud::AccessApproval::V1::AccessApproval::Rest::ServiceStub.

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

Inherits

Object

Methods

#approve_approval_request

def approve_approval_request(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::ApprovalRequest

Baseline implementation for the approve_approval_request REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage) — 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

result (::Google::Cloud::AccessApproval::V1::ApprovalRequest)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::ApprovalRequest) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_access_approval_settings

def delete_access_approval_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_access_approval_settings REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage) — 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

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#dismiss_approval_request

def dismiss_approval_request(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::ApprovalRequest

Baseline implementation for the dismiss_approval_request REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage) — 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

result (::Google::Cloud::AccessApproval::V1::ApprovalRequest)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::ApprovalRequest) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_access_approval_service_account

def get_access_approval_service_account(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::AccessApprovalServiceAccount

Baseline implementation for the get_access_approval_service_account REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::GetAccessApprovalServiceAccountMessage) — 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

result (::Google::Cloud::AccessApproval::V1::AccessApprovalServiceAccount)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::AccessApprovalServiceAccount) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_access_approval_settings

def get_access_approval_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::AccessApprovalSettings

Baseline implementation for the get_access_approval_settings REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage) — 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

result (::Google::Cloud::AccessApproval::V1::AccessApprovalSettings)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::AccessApprovalSettings) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_approval_request

def get_approval_request(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::ApprovalRequest

Baseline implementation for the get_approval_request REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage) — 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

result (::Google::Cloud::AccessApproval::V1::ApprovalRequest)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::ApprovalRequest) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#invalidate_approval_request

def invalidate_approval_request(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::ApprovalRequest

Baseline implementation for the invalidate_approval_request REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::InvalidateApprovalRequestMessage) — 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

result (::Google::Cloud::AccessApproval::V1::ApprovalRequest)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::ApprovalRequest) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list_approval_requests

def list_approval_requests(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::ListApprovalRequestsResponse

Baseline implementation for the list_approval_requests REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage) — 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

result (::Google::Cloud::AccessApproval::V1::ListApprovalRequestsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::ListApprovalRequestsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_access_approval_settings

def update_access_approval_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AccessApproval::V1::AccessApprovalSettings

Baseline implementation for the update_access_approval_settings REST call

Parameters

request_pb (::Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage) — 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

result (::Google::Cloud::AccessApproval::V1::AccessApprovalSettings)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::AccessApproval::V1::AccessApprovalSettings) — A result object deserialized from the server's reply

Raises

(::ArgumentError)