Class: Google::Apis::ServicedirectoryV1::ServiceDirectoryService

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

Overview

Service Directory API

Service Directory is a platform for discovering, publishing, and connecting services.

Examples:

require 'google/apis/servicedirectory_v1'

Servicedirectory = Google::Apis::ServicedirectoryV1 # Alias the module
service = Servicedirectory::ServiceDirectoryService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://servicedirectory.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServiceDirectoryService

Returns a new instance of ServiceDirectoryService.



48
49
50
51
52
53
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-servicedirectory_v1',
        client_version: Google::Apis::ServicedirectoryV1::GEM_VERSION)
  @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.

Returns:

  • (String) —

    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.



41
42
43
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 41

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.

Returns:

  • (String) —

    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.



46
47
48
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#create_project_location_namespace(parent, namespace_object = nil, namespace_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Namespace

Creates a namespace, and returns the new namespace.

Parameters:

  • parent (String) —

    Required. The resource name of the project and location the namespace will be created in.

  • namespace_object (Google::Apis::ServicedirectoryV1::Namespace) (defaults to: nil)
  • namespace_id (String) (defaults to: nil) —

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]0,61[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 157

def create_project_location_namespace(parent, namespace_object = nil, namespace_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/namespaces', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::Namespace::Representation
  command.request_object = namespace_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Namespace::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Namespace
  command.params['parent'] = parent unless parent.nil?
  command.query['namespaceId'] = namespace_id unless namespace_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

#create_project_location_namespace_service(parent, service_object = nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Service

Creates a service, and returns the new service.

Parameters:

  • parent (String) —

    Required. The resource name of the namespace this service will belong to.

  • service_object (Google::Apis::ServicedirectoryV1::Service) (defaults to: nil)
  • service_id (String) (defaults to: nil) —

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]0,61[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 462

def create_project_location_namespace_service(parent, service_object = nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/services', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Service::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Service
  command.params['parent'] = parent unless parent.nil?
  command.query['serviceId'] = service_id unless service_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

#create_project_location_namespace_service_endpoint(parent, endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Endpoint

Creates an endpoint, and returns the new endpoint.

Parameters:

  • parent (String) —

    Required. The resource name of the service that this endpoint provides.

  • endpoint_object (Google::Apis::ServicedirectoryV1::Endpoint) (defaults to: nil)
  • endpoint_id (String) (defaults to: nil) —

    Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]0,61[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 800

def create_project_location_namespace_service_endpoint(parent, endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/endpoints', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::Endpoint::Representation
  command.request_object = endpoint_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Endpoint::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Endpoint
  command.params['parent'] = parent unless parent.nil?
  command.query['endpointId'] = endpoint_id unless endpoint_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_location_namespace(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Empty

Deletes a namespace. This also deletes all services and endpoints in the namespace.

Parameters:

  • name (String) —

    Required. The name of the namespace to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 191

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

#delete_project_location_namespace_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Empty

Deletes a service. This also deletes all endpoints associated with the service.

Parameters:

  • name (String) —

    Required. The name of the service to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



495
496
497
498
499
500
501
502
503
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 495

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

#delete_project_location_namespace_service_endpoint(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Empty

Deletes an endpoint.

Parameters:

  • name (String) —

    Required. The name of the endpoint to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



833
834
835
836
837
838
839
840
841
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 833

def delete_project_location_namespace_service_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::Empty::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::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_namespace_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Policy

Gets the IAM Policy for a resource (namespace or service only).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::ServicedirectoryV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 254

def get_namespace_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Policy::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Policy
  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

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 75

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::Location::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Location
  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_location_namespace(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Namespace

Gets a namespace.

Parameters:

  • name (String) —

    Required. The name of the namespace to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



221
222
223
224
225
226
227
228
229
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 221

def get_project_location_namespace(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::Namespace::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Namespace
  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_location_namespace_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Service

Gets a service.

Parameters:

  • name (String) —

    Required. The name of the service to get.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



525
526
527
528
529
530
531
532
533
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 525

def get_project_location_namespace_service(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::Service::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Service
  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_location_namespace_service_endpoint(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Endpoint

Gets an endpoint.

Parameters:

  • name (String) —

    Required. The name of the endpoint to get.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



863
864
865
866
867
868
869
870
871
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 863

def get_project_location_namespace_service_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::Endpoint::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Endpoint
  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_service_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Policy

Gets the IAM Policy for a resource (namespace or service only).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::ServicedirectoryV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 558

def get_service_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Policy::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Policy
  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

#list_project_location_namespace_service_endpoints(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::ListEndpointsResponse

Lists all endpoints.

Parameters:

  • parent (String) —

    Required. The resource name of the service whose endpoints you'd like to list.

  • filter (String) (defaults to: nil) —

    Optional. The filter to list results by. General filter string syntax: ()

    • can be `name`, `address`, `port`, or `annotations.` for map field * can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as = * must be the same data type as field * can be AND, OR, NOT Examples of valid filters: * annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner * annotations.protocol=gRPC returns endpoints that have key/value protocol=gRPC * address=192.108.1.105 returns endpoints that have this address * port>8080 returns endpoints that have port number larger than 8080 * name>projects/my-project/locations/us-east1/namespaces/my- namespace/services/my-service/endpoints/endpoint-c returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not * annotations.owner!=sd AND annotations.foo= bar returns endpoints that have owner in annotation key but value is not sd AND have key/value foo=bar * doesnotexist.foo=bar returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results For more information about filtering, see API Filtering.
  • order_by (String) (defaults to: nil) —

    Optional. The order to list results by. General order_by string syntax: () (,) * allows values: `name`, `address`, `port` * ascending or descending order by `. If this is left blank,ascis used Note that an emptyorder_bystring results in default order, which is order byname` in ascending order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 923

def list_project_location_namespace_service_endpoints(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/endpoints', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::ListEndpointsResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::ListEndpointsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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

#list_project_location_namespace_services(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::ListServicesResponse

Lists all services belonging to a namespace.

Parameters:

  • parent (String) —

    Required. The resource name of the namespace whose services you'd like to list.

  • filter (String) (defaults to: nil) —

    Optional. The filter to list results by. General filter string syntax: ()

    • can be `name` or `annotations.` for map field * can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
    • must be the same data type as field * can be AND, OR, NOT Examples of valid filters: * annotations.owner returns services that have a annotation with the key owner, this is the same as annotations:owner * annotations.protocol=gRPC returns services that have key/value protocol=gRPC
    • name>projects/my-project/locations/us-east1/namespaces/my-namespace/ services/service-c returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not * annotations.owner!=sd AND annotations.foo=bar returns services that have owner in annotation key but value is not sd AND have key/value foo=bar * doesnotexist.foo=bar returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results For more information about filtering, see API Filtering.
  • order_by (String) (defaults to: nil) —

    Optional. The order to list results by. General order_by string syntax: () (,) * allows value: `name` * ascending or descending order by `. If this is left blank,ascis used Note that an emptyorder_bystring results in default order, which is order byname` in ascending order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 617

def list_project_location_namespace_services(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/services', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::ListServicesResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::ListServicesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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

#list_project_location_namespaces(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::ListNamespacesResponse

Lists all namespaces.

Parameters:

  • parent (String) —

    Required. The resource name of the project and location whose namespaces you'd like to list.

  • filter (String) (defaults to: nil) —

    Optional. The filter to list results by. General filter string syntax: ()

    • can be `name` or `labels.` for map field * can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as = * must be the same data type as field * can be AND, OR, NOT Examples of valid filters: * labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner * labels.owner=sd returns namespaces that have key/value owner=sd * name>projects/my-project/ locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not * labels.owner!=sd AND labels.foo=bar returns namespaces that have owner in label key but value is not sd AND have key/ value foo=bar * doesnotexist.foo=bar returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results For more information about filtering, see API Filtering.
  • order_by (String) (defaults to: nil) —

    Optional. The order to list results by. General order_by string syntax: () (,) * allows value: `name` * ascending or descending order by `. If this is left blank,ascis used Note that an emptyorder_bystring results in default order, which is order byname` in ascending order.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of items to return.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 313

def list_project_location_namespaces(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/namespaces', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::ListNamespacesResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::ListNamespacesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil) —

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 115

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::ServicedirectoryV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::ListLocationsResponse
  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

#patch_project_location_namespace(name, namespace_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Namespace

Updates a namespace.

Parameters:

  • name (String) —

    Immutable. The resource name for the namespace in the format projects/*/ locations/*/namespaces/*.

  • namespace_object (Google::Apis::ServicedirectoryV1::Namespace) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. List of fields to be updated in this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 351

def patch_project_location_namespace(name, namespace_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::Namespace::Representation
  command.request_object = namespace_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Namespace::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Namespace
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_namespace_service(name, service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Service

Updates a service.

Parameters:

  • name (String) —

    Immutable. The resource name for the service in the format projects/*/ locations/*/namespaces/*/services/*.

  • service_object (Google::Apis::ServicedirectoryV1::Service) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. List of fields to be updated in this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 655

def patch_project_location_namespace_service(name, service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Service::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Service
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_namespace_service_endpoint(name, endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Endpoint

Updates an endpoint.

Parameters:

  • name (String) —

    Immutable. The resource name for the endpoint in the format projects/*/ locations/*/namespaces/*/services/*/endpoints/*.

  • endpoint_object (Google::Apis::ServicedirectoryV1::Endpoint) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. List of fields to be updated in this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 961

def patch_project_location_namespace_service_endpoint(name, endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::Endpoint::Representation
  command.request_object = endpoint_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Endpoint::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Endpoint
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resolve_service(name, resolve_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::ResolveServiceResponse

Returns a service and its associated endpoints. Resolving a service is not considered an active developer method.

Parameters:

  • name (String) —

    Required. The name of the service to resolve.

  • resolve_service_request_object (Google::Apis::ServicedirectoryV1::ResolveServiceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 690

def resolve_service(name, resolve_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resolve', options)
  command.request_representation = Google::Apis::ServicedirectoryV1::ResolveServiceRequest::Representation
  command.request_object = resolve_service_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::ResolveServiceResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::ResolveServiceResponse
  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

#set_namespace_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Policy

Sets the IAM Policy for a resource (namespace or service only).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::ServicedirectoryV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 387

def set_namespace_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::ServicedirectoryV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Policy::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Policy
  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_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::Policy

Sets the IAM Policy for a resource (namespace or service only).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::ServicedirectoryV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 725

def set_service_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::ServicedirectoryV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::Policy::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::Policy
  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_namespace_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::TestIamPermissionsResponse

Tests IAM permissions for a resource (namespace or service only).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::ServicedirectoryV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 422

def test_namespace_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::ServicedirectoryV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::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_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicedirectoryV1::TestIamPermissionsResponse

Tests IAM permissions for a resource (namespace or service only).

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::ServicedirectoryV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/google/apis/servicedirectory_v1/service.rb', line 760

def test_service_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::ServicedirectoryV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ServicedirectoryV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ServicedirectoryV1::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