Class: Google::Apis::BinaryauthorizationV1::BinaryAuthorizationService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/binaryauthorization_v1/service.rb

Overview

Binary Authorization API

The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters.

Examples:

require 'google/apis/binaryauthorization_v1'

Binaryauthorization = Google::Apis::BinaryauthorizationV1 # Alias the module
service = Binaryauthorization::BinaryAuthorizationService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeBinaryAuthorizationService


46
47
48
49
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 46

def initialize
  super('https://binaryauthorization.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


39
40
41
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 39

def key
  @key
end

#quota_userString


44
45
46
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#create_project_attestor(parent, attestor_object = nil, attestor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::Attestor

Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


151
152
153
154
155
156
157
158
159
160
161
162
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 151

def create_project_attestor(parent, attestor_object = nil, attestor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/attestors', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::Attestor::Representation
  command.request_object = attestor_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::Attestor::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::Attestor
  command.params['parent'] = parent unless parent.nil?
  command.query['attestorId'] = attestor_id unless attestor_id.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_project_attestor(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::Empty

Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


186
187
188
189
190
191
192
193
194
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 186

def delete_project_attestor(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BinaryauthorizationV1::Empty::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::Empty
  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

#get_project_attestor(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::Attestor

Gets an attestor. Returns NOT_FOUND if the attestor does not exist.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


218
219
220
221
222
223
224
225
226
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 218

def get_project_attestor(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BinaryauthorizationV1::Attestor::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::Attestor
  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

#get_project_attestor_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::IamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


258
259
260
261
262
263
264
265
266
267
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 258

def get_project_attestor_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::BinaryauthorizationV1::IamPolicy::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::IamPolicy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.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_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::Policy

A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


77
78
79
80
81
82
83
84
85
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 77

def get_project_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BinaryauthorizationV1::Policy::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::Policy
  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

#get_project_policy_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::IamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


450
451
452
453
454
455
456
457
458
459
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 450

def get_project_policy_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::BinaryauthorizationV1::IamPolicy::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::IamPolicy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.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_project_attestors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::ListAttestorsResponse

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


298
299
300
301
302
303
304
305
306
307
308
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 298

def list_project_attestors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/attestors', options)
  command.response_representation = Google::Apis::BinaryauthorizationV1::ListAttestorsResponse::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::ListAttestorsResponse
  command.params['parent'] = parent unless parent.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

#set_attestor_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::IamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


334
335
336
337
338
339
340
341
342
343
344
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 334

def set_attestor_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::IamPolicy::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::IamPolicy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::IamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


485
486
487
488
489
490
491
492
493
494
495
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 485

def set_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::IamPolicy::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::IamPolicy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_attestor_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


373
374
375
376
377
378
379
380
381
382
383
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 373

def test_attestor_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_policy_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


524
525
526
527
528
529
530
531
532
533
534
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 524

def test_policy_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_attestor(name, attestor_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::Attestor

Updates an attestor. Returns NOT_FOUND if the attestor does not exist.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


408
409
410
411
412
413
414
415
416
417
418
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 408

def update_project_attestor(name, attestor_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::Attestor::Representation
  command.request_object = attestor_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::Attestor::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::Attestor
  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

#update_project_policy(name, policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BinaryauthorizationV1::Policy

Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


113
114
115
116
117
118
119
120
121
122
123
# File 'generated/google/apis/binaryauthorization_v1/service.rb', line 113

def update_project_policy(name, policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::BinaryauthorizationV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::BinaryauthorizationV1::Policy::Representation
  command.response_class = Google::Apis::BinaryauthorizationV1::Policy
  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