Class: Google::Apis::RemotebuildexecutionV1::RemoteBuildExecutionService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::RemotebuildexecutionV1::RemoteBuildExecutionService
- Defined in:
- generated/google/apis/remotebuildexecution_v1/service.rb
Overview
Remote Build Execution API
Supplies a Remote Execution API service for tools such as bazel.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#cancel_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty
Starts asynchronous cancellation on a long-running operation.
-
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty
Deletes a long-running operation.
-
#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia
Downloads media.
-
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#initialize ⇒ RemoteBuildExecutionService
constructor
A new instance of RemoteBuildExecutionService.
-
#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
-
#upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia
Uploads media.
-
#watch(resume_marker: nil, target: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleWatcherV1ChangeBatch
Start a streaming RPC to get watch information from the server.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ RemoteBuildExecutionService
Returns a new instance of RemoteBuildExecutionService
45 46 47 48 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 45 def initialize super('https://remotebuildexecution.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#cancel_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
164 165 166 167 168 169 170 171 172 173 174 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 164 def cancel_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', ) command.request_representation = Google::Apis::RemotebuildexecutionV1::GoogleLongrunningCancelOperationRequest::Representation command.request_object = google_longrunning_cancel_operation_request_object command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
199 200 201 202 203 204 205 206 207 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 199 def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia
Downloads media. Download is supported
on the URI /v1/media/
+name?alt=media
.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 74 def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'v1/media/{+resourceName}', ) else command = make_download_command(:get, 'v1/media/{+resourceName}', ) command.download_dest = download_dest end command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia command.params['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleLongrunningOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
278 279 280 281 282 283 284 285 286 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 278 def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/
name=users/*/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 243 def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleLongrunningListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia
Uploads media. Upload is supported on
the URI /upload/v1/media/
+name``.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 116 def upload_medium(resource_name, google_bytestream_media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'v1/media/{+resourceName}', ) else command = make_upload_command(:post, 'v1/media/{+resourceName}', ) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia::Representation command.request_object = google_bytestream_media_object command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia command.params['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#watch(resume_marker: nil, target: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV1::GoogleWatcherV1ChangeBatch
Start a streaming RPC to get watch information from the server.
354 355 356 357 358 359 360 361 362 363 |
# File 'generated/google/apis/remotebuildexecution_v1/service.rb', line 354 def watch(resume_marker: nil, target: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1:watch', ) command.response_representation = Google::Apis::RemotebuildexecutionV1::GoogleWatcherV1ChangeBatch::Representation command.response_class = Google::Apis::RemotebuildexecutionV1::GoogleWatcherV1ChangeBatch command.query['resumeMarker'] = resume_marker unless resume_marker.nil? command.query['target'] = target unless target.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |