Grafeas V1 API - Class Grafeas::V1::Grafeas::Rest::ServiceStub (v0.16.0)

Version latest

• 0.16.1 (latest)
• 0.16.0
• 0.15.0
• 0.14.2
• 0.13.0
• 0.12.1
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.1

Reference documentation and code samples for the Grafeas V1 API class Grafeas::V1::Grafeas::Rest::ServiceStub.

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

Inherits

• Object

Methods

#batch_create_notes

def batch_create_notes(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::BatchCreateNotesResponse

Baseline implementation for the batch_create_notes REST call

Parameters

• request_pb (::Grafeas::V1::BatchCreateNotesRequest) — 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 (::Grafeas::V1::BatchCreateNotesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::BatchCreateNotesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#batch_create_occurrences

def batch_create_occurrences(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::BatchCreateOccurrencesResponse

Baseline implementation for the batch_create_occurrences REST call

Parameters

• request_pb (::Grafeas::V1::BatchCreateOccurrencesRequest) — 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 (::Grafeas::V1::BatchCreateOccurrencesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::BatchCreateOccurrencesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_note

def create_note(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Note

Baseline implementation for the create_note REST call

Parameters

• request_pb (::Grafeas::V1::CreateNoteRequest) — 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 (::Grafeas::V1::Note)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Note) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_occurrence

def create_occurrence(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Occurrence

Baseline implementation for the create_occurrence REST call

Parameters

• request_pb (::Grafeas::V1::CreateOccurrenceRequest) — 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 (::Grafeas::V1::Occurrence)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Occurrence) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_note

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

Baseline implementation for the delete_note REST call

Parameters

• request_pb (::Grafeas::V1::DeleteNoteRequest) — 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)

#delete_occurrence

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

Baseline implementation for the delete_occurrence REST call

Parameters

• request_pb (::Grafeas::V1::DeleteOccurrenceRequest) — 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)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_note

def get_note(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Note

Baseline implementation for the get_note REST call

Parameters

• request_pb (::Grafeas::V1::GetNoteRequest) — 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 (::Grafeas::V1::Note)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Note) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_occurrence

def get_occurrence(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Occurrence

Baseline implementation for the get_occurrence REST call

Parameters

• request_pb (::Grafeas::V1::GetOccurrenceRequest) — 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 (::Grafeas::V1::Occurrence)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Occurrence) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_occurrence_note

def get_occurrence_note(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Note

Baseline implementation for the get_occurrence_note REST call

Parameters

• request_pb (::Grafeas::V1::GetOccurrenceNoteRequest) — 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 (::Grafeas::V1::Note)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Note) — 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

#list_note_occurrences

def list_note_occurrences(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::ListNoteOccurrencesResponse

Baseline implementation for the list_note_occurrences REST call

Parameters

• request_pb (::Grafeas::V1::ListNoteOccurrencesRequest) — 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 (::Grafeas::V1::ListNoteOccurrencesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::ListNoteOccurrencesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_notes

def list_notes(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::ListNotesResponse

Baseline implementation for the list_notes REST call

Parameters

• request_pb (::Grafeas::V1::ListNotesRequest) — 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 (::Grafeas::V1::ListNotesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::ListNotesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_occurrences

def list_occurrences(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::ListOccurrencesResponse

Baseline implementation for the list_occurrences REST call

Parameters

• request_pb (::Grafeas::V1::ListOccurrencesRequest) — 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 (::Grafeas::V1::ListOccurrencesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::ListOccurrencesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_note

def update_note(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Note

Baseline implementation for the update_note REST call

Parameters

• request_pb (::Grafeas::V1::UpdateNoteRequest) — 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 (::Grafeas::V1::Note)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Note) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_occurrence

def update_occurrence(request_pb, options = nil) { |result, operation| ... } -> ::Grafeas::V1::Occurrence

Baseline implementation for the update_occurrence REST call

Parameters

• request_pb (::Grafeas::V1::UpdateOccurrenceRequest) — 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 (::Grafeas::V1::Occurrence)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Grafeas::V1::Occurrence) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)