Class: Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb

Overview

Client for the ManagedIdentitiesService service.

API Overview

The managedidentites.googleapis.com service implements the Google Cloud Managed Identites API for identity services (e.g. Microsoft Active Directory).

The Managed Identities service provides methods to manage (create/read/update/delete) domains, reset managed identities admin password, add/remove domain controllers in GCP regions and add/remove VPC peering.

Data Model

The Managed Identities service exposes the following resources:

  • Locations as global, named as follows: projects/{project_id}/locations/global.

  • Domains, named as follows: /projects/{project_id}/locations/global/domain/{domain_name}.

The {domain_name} refers to fully qualified domain name in the customer project e.g. mydomain.myorganization.com, with the following restrictions:

  • Must contain only lowercase letters, numbers, periods and hyphens.
  • Must start with a letter.
  • Must contain between 2-64 characters.
  • Must end with a number or a letter.
  • Must not start with period.
  • First segement length (mydomain form example above) shouldn't exceed 15 chars.
  • The last segment cannot be fully numeric.
  • Must be unique within the customer project.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#domain_path, #location_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ManagedIdentitiesService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ManagedIdentitiesService client.

Yield Parameters:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 175

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/managedidentities/v1/managed_identities_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @managed_identities_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



227
228
229
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 227

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ManagedIdentitiesService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ManagedIdentitiesService clients
::Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 93

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ManagedIdentities", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_microsoft_ad_domain.timeout = 60.0

    default_config.rpcs.reset_admin_password.timeout = 60.0

    default_config.rpcs.list_domains.timeout = 60.0

    default_config.rpcs.get_domain.timeout = 60.0

    default_config.rpcs.update_domain.timeout = 60.0

    default_config.rpcs.delete_domain.timeout = 60.0

    default_config.rpcs.attach_trust.timeout = 60.0

    default_config.rpcs.reconfigure_trust.timeout = 60.0

    default_config.rpcs.detach_trust.timeout = 60.0

    default_config.rpcs.validate_trust.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#attach_trust(request, options = nil) ⇒ ::Gapic::Operation #attach_trust(name: nil, trust: nil) ⇒ ::Gapic::Operation

Adds an AD trust to a domain.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::AttachTrustRequest.new

# Call the attach_trust method.
result = client.attach_trust request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #attach_trust(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to attach_trust via a request object, either of type AttachTrustRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::AttachTrustRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #attach_trust(name: nil, trust: nil) ⇒ ::Gapic::Operation

    Pass arguments to attach_trust via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

    • trust (::Google::Cloud::ManagedIdentities::V1::Trust, ::Hash) (defaults to: nil) —

      Required. The domain trust resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 876

def attach_trust request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::AttachTrustRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.attach_trust.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.attach_trust.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.attach_trust.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :attach_trust, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the ManagedIdentitiesService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



145
146
147
148
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 145

def configure
  yield @config if block_given?
  @config
end

#create_microsoft_ad_domain(request, options = nil) ⇒ ::Gapic::Operation #create_microsoft_ad_domain(parent: nil, domain_name: nil, domain: nil) ⇒ ::Gapic::Operation

Creates a Microsoft AD domain.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::CreateMicrosoftAdDomainRequest.new

# Call the create_microsoft_ad_domain method.
result = client.create_microsoft_ad_domain request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_microsoft_ad_domain(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_microsoft_ad_domain via a request object, either of type CreateMicrosoftAdDomainRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::CreateMicrosoftAdDomainRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_microsoft_ad_domain(parent: nil, domain_name: nil, domain: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_microsoft_ad_domain via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The resource project name and location using the form: projects/{project_id}/locations/global

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

      Required. The fully qualified domain name. e.g. mydomain.myorganization.com, with the following restrictions:

      • Must contain only lowercase letters, numbers, periods and hyphens.
      • Must start with a letter.
      • Must contain between 2-64 characters.
      • Must end with a number or a letter.
      • Must not start with period.
      • First segement length (mydomain form example above) shouldn't exceed 15 chars.
      • The last segment cannot be fully numeric.
      • Must be unique within the customer project.
    • domain (::Google::Cloud::ManagedIdentities::V1::Domain, ::Hash) (defaults to: nil) —

      Required. A Managed Identity domain resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 298

def create_microsoft_ad_domain request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::CreateMicrosoftAdDomainRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_microsoft_ad_domain.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_microsoft_ad_domain.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_microsoft_ad_domain.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :create_microsoft_ad_domain, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_domain(request, options = nil) ⇒ ::Gapic::Operation #delete_domain(name: nil) ⇒ ::Gapic::Operation

Deletes a domain.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::DeleteDomainRequest.new

# Call the delete_domain method.
result = client.delete_domain request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_domain(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_domain via a request object, either of type DeleteDomainRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::DeleteDomainRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_domain(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_domain via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 779

def delete_domain request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::DeleteDomainRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_domain.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_domain.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_domain.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :delete_domain, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#detach_trust(request, options = nil) ⇒ ::Gapic::Operation #detach_trust(name: nil, trust: nil) ⇒ ::Gapic::Operation

Removes an AD trust.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::DetachTrustRequest.new

# Call the detach_trust method.
result = client.detach_trust request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #detach_trust(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to detach_trust via a request object, either of type DetachTrustRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::DetachTrustRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #detach_trust(name: nil, trust: nil) ⇒ ::Gapic::Operation

    Pass arguments to detach_trust via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

    • trust (::Google::Cloud::ManagedIdentities::V1::Trust, ::Hash) (defaults to: nil) —

      Required. The domain trust resource to removed.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 1074

def detach_trust request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::DetachTrustRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.detach_trust.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.detach_trust.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.detach_trust.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :detach_trust, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_domain(request, options = nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::Domain #get_domain(name: nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::Domain

Gets information about a domain.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::GetDomainRequest.new

# Call the get_domain method.
result = client.get_domain request

# The returned object is of type Google::Cloud::ManagedIdentities::V1::Domain.
p result

Overloads:

  • #get_domain(request, options = nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::Domain

    Pass arguments to get_domain via a request object, either of type GetDomainRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::GetDomainRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_domain(name: nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::Domain

    Pass arguments to get_domain via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 583

def get_domain request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::GetDomainRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_domain.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_domain.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_domain.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :get_domain, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_domains(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedIdentities::V1::Domain> #list_domains(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedIdentities::V1::Domain>

Lists domains in a project.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::ListDomainsRequest.new

# Call the list_domains method.
result = client.list_domains request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ManagedIdentities::V1::Domain.
  p item
end

Overloads:

  • #list_domains(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedIdentities::V1::Domain>

    Pass arguments to list_domains via a request object, either of type ListDomainsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::ListDomainsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_domains(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ManagedIdentities::V1::Domain>

    Pass arguments to list_domains via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The resource name of the domain location using the form: projects/{project_id}/locations/global

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

      Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used. Regardless of the page_size value, the response may include a partial list. Callers should rely on a response's next_page_token to determine if there are additional results to list.

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

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

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

      Optional. A filter specifying constraints of a list operation. For example, Domain.fqdn="mydomain.myorginization".

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

      Optional. Specifies the ordering of results. See Sorting order for more information.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 495

def list_domains request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::ListDomainsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_domains.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_domains.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_domains.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :list_domains, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @managed_identities_service_stub, :list_domains, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reconfigure_trust(request, options = nil) ⇒ ::Gapic::Operation #reconfigure_trust(name: nil, target_domain_name: nil, target_dns_ip_addresses: nil) ⇒ ::Gapic::Operation

Updates the DNS conditional forwarder.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::ReconfigureTrustRequest.new

# Call the reconfigure_trust method.
result = client.reconfigure_trust request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #reconfigure_trust(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to reconfigure_trust via a request object, either of type ReconfigureTrustRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::ReconfigureTrustRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #reconfigure_trust(name: nil, target_domain_name: nil, target_dns_ip_addresses: nil) ⇒ ::Gapic::Operation

    Pass arguments to reconfigure_trust via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

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

      Required. The fully-qualified target domain name which will be in trust with current domain.

    • target_dns_ip_addresses (::Array<::String>) (defaults to: nil) —

      Required. The target DNS server IP addresses to resolve the remote domain involved in the trust.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 977

def reconfigure_trust request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::ReconfigureTrustRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reconfigure_trust.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reconfigure_trust.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reconfigure_trust.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :reconfigure_trust, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reset_admin_password(request, options = nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordResponse #reset_admin_password(name: nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordResponse

Resets a domain's administrator password.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordRequest.new

# Call the reset_admin_password method.
result = client.reset_admin_password request

# The returned object is of type Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordResponse.
p result

Overloads:

  • #reset_admin_password(request, options = nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordResponse

    Pass arguments to reset_admin_password via a request object, either of type ResetAdminPasswordRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #reset_admin_password(name: nil) ⇒ ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordResponse

    Pass arguments to reset_admin_password via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 386

def reset_admin_password request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reset_admin_password.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reset_admin_password.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reset_admin_password.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :reset_admin_password, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


155
156
157
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 155

def universe_domain
  @managed_identities_service_stub.universe_domain
end

#update_domain(request, options = nil) ⇒ ::Gapic::Operation #update_domain(update_mask: nil, domain: nil) ⇒ ::Gapic::Operation

Updates the metadata and configuration of a domain.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::UpdateDomainRequest.new

# Call the update_domain method.
result = client.update_domain request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_domain(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_domain via a request object, either of type UpdateDomainRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::UpdateDomainRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_domain(update_mask: nil, domain: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_domain via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include fields from Domain:

      • labels
      • locations
      • authorized_networks
    • domain (::Google::Cloud::ManagedIdentities::V1::Domain, ::Hash) (defaults to: nil) —

      Required. Domain message with updated fields. Only supported fields specified in update_mask are updated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 684

def update_domain request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::UpdateDomainRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_domain.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.domain&.name
    header_params["domain.name"] = request.domain.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_domain.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_domain.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :update_domain, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#validate_trust(request, options = nil) ⇒ ::Gapic::Operation #validate_trust(name: nil, trust: nil) ⇒ ::Gapic::Operation

Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.

Examples:

Basic example

require "google/cloud/managed_identities/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedIdentities::V1::ValidateTrustRequest.new

# Call the validate_trust method.
result = client.validate_trust request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #validate_trust(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to validate_trust via a request object, either of type ValidateTrustRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::ManagedIdentities::V1::ValidateTrustRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #validate_trust(name: nil, trust: nil) ⇒ ::Gapic::Operation

    Pass arguments to validate_trust via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

    • trust (::Google::Cloud::ManagedIdentities::V1::Trust, ::Hash) (defaults to: nil) —

      Required. The domain trust to validate trust state for.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb', line 1172

def validate_trust request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ManagedIdentities::V1::ValidateTrustRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.validate_trust.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ManagedIdentities::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.validate_trust.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.validate_trust.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @managed_identities_service_stub.call_rpc :validate_trust, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end