Class: Google::Cloud::Build::V2::RepositoryManager::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/build/v2/repository_manager/client.rb

Overview

Client for the RepositoryManager service.

Manages connections to source code repositories.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#connection_path, #location_path, #repository_path, #secret_version_path, #service_path

Constructor Details

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

Create a new RepositoryManager client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Build::V2::RepositoryManager::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the RepositoryManager client.

Yield Parameters:



171
172
173
174
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 171

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/devtools/cloudbuild/v2/repositories_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

  @repository_manager_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Build::V2::RepositoryManager::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,
    logger: @config.logger
  )

  @repository_manager_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @repository_manager_stub.endpoint
    config.universe_domain = @repository_manager_stub.universe_domain
    config.logger = @repository_manager_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @repository_manager_stub.endpoint
    config.universe_domain = @repository_manager_stub.universe_domain
    config.logger = @repository_manager_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

  • (Google::Iam::V1::IAMPolicy::Client) 


264
265
266
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 264

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Client) 


257
258
259
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 257

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::Build::V2::RepositoryManager::Operations (readonly)

Get the associated client for long-running operations.

Returns:



250
251
252
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 250

def operations_client
  @operations_client
end

Class Method Details

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

Configure the RepositoryManager Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all RepositoryManager clients
::Google::Cloud::Build::V2::RepositoryManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Build", "V2"]
    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_connection.timeout = 60.0

    default_config.rpcs.get_connection.timeout = 60.0
    default_config.rpcs.get_connection.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_connections.timeout = 60.0
    default_config.rpcs.list_connections.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_connection.timeout = 60.0

    default_config.rpcs.delete_connection.timeout = 60.0

    default_config.rpcs.create_repository.timeout = 60.0

    default_config.rpcs.get_repository.timeout = 60.0
    default_config.rpcs.get_repository.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_repositories.timeout = 60.0
    default_config.rpcs.list_repositories.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_repository.timeout = 60.0

    default_config.rpcs.fetch_read_write_token.timeout = 60.0
    default_config.rpcs.fetch_read_write_token.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.fetch_read_token.timeout = 60.0
    default_config.rpcs.fetch_read_token.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.fetch_linkable_repositories.timeout = 60.0
    default_config.rpcs.fetch_linkable_repositories.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_create_repositories(request, options = nil) ⇒ ::Gapic::Operation #batch_create_repositories(parent: nil, requests: nil) ⇒ ::Gapic::Operation

Creates multiple repositories inside a connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::BatchCreateRepositoriesRequest.new

# Call the batch_create_repositories method.
result = client.batch_create_repositories 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:

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

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

    Parameters:

    • request (::Google::Cloud::Build::V2::BatchCreateRepositoriesRequest, ::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.

  • #batch_create_repositories(parent: nil, requests: nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_create_repositories 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 connection to contain all the repositories being created. Format: projects//locations//connections/* The parent field in the CreateRepositoryRequest messages must either be empty or match this field.

    • requests (::Array<::Google::Cloud::Build::V2::CreateRepositoryRequest, ::Hash>) (defaults to: nil) —

      Required. The request messages specifying the repositories to create.

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.



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 927

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::BatchCreateRepositoriesRequest

  # 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.batch_create_repositories.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::Build::V2::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.batch_create_repositories.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_create_repositories.retry_policy

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

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

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

Configure the RepositoryManager 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:



141
142
143
144
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 141

def configure
  yield @config if block_given?
  @config
end

#create_connection(request, options = nil) ⇒ ::Gapic::Operation #create_connection(parent: nil, connection: nil, connection_id: nil) ⇒ ::Gapic::Operation

Creates a Connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::CreateConnectionRequest.new

# Call the create_connection method.
result = client.create_connection 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_connection(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Build::V2::CreateConnectionRequest, ::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_connection(parent: nil, connection: nil, connection_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_connection 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. Project and location where the connection will be created. Format: projects/*/locations/*.

    • connection (::Google::Cloud::Build::V2::Connection, ::Hash) (defaults to: nil) —

      Required. The Connection to create.

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

      Required. The ID to use for the Connection, which will become the final component of the Connection's resource name. Names must be unique per-project per-location. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.

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.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 336

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::CreateConnectionRequest

  # 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_connection.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::Build::V2::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_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_connection.retry_policy

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

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

#create_repository(request, options = nil) ⇒ ::Gapic::Operation #create_repository(parent: nil, repository: nil, repository_id: nil) ⇒ ::Gapic::Operation

Creates a Repository.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::CreateRepositoryRequest.new

# Call the create_repository method.
result = client.create_repository 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_repository(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Build::V2::CreateRepositoryRequest, ::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_repository(parent: nil, repository: nil, repository_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_repository 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 connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there.

    • repository (::Google::Cloud::Build::V2::Repository, ::Hash) (defaults to: nil) —

      Required. The repository to create.

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

      Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.

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.



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 828

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::CreateRepositoryRequest

  # 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_repository.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::Build::V2::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_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_repository.retry_policy

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

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

#delete_connection(request, options = nil) ⇒ ::Gapic::Operation #delete_connection(name: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

Deletes a single connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::DeleteConnectionRequest.new

# Call the delete_connection method.
result = client.delete_connection 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_connection(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Build::V2::DeleteConnectionRequest, ::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_connection(name: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_connection 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 name of the Connection to delete. Format: projects/*/locations/*/connections/*.

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

      The current etag of the connection. If an etag is provided and does not match the current etag of the connection, deletion will be blocked and an ABORTED error will be returned.

    • validate_only (::Boolean) (defaults to: nil) —

      If set, validate the request, but do not actually post it.

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.



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 725

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::DeleteConnectionRequest

  # 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_connection.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::Build::V2::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_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_connection.retry_policy

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

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

#delete_repository(request, options = nil) ⇒ ::Gapic::Operation #delete_repository(name: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

Deletes a single repository.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::DeleteRepositoryRequest.new

# Call the delete_repository method.
result = client.delete_repository 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_repository(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Build::V2::DeleteRepositoryRequest, ::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_repository(name: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_repository 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 name of the Repository to delete. Format: projects/*/locations/*/connections/*/repositories/*.

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

      The current etag of the repository. If an etag is provided and does not match the current etag of the repository, deletion will be blocked and an ABORTED error will be returned.

    • validate_only (::Boolean) (defaults to: nil) —

      If set, validate the request, but do not actually post it.

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.



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1215

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::DeleteRepositoryRequest

  # 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_repository.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::Build::V2::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_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_repository.retry_policy

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

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

#fetch_git_refs(request, options = nil) ⇒ ::Google::Cloud::Build::V2::FetchGitRefsResponse #fetch_git_refs(repository: nil, ref_type: nil) ⇒ ::Google::Cloud::Build::V2::FetchGitRefsResponse

Fetch the list of branches or tags for a given repository.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::FetchGitRefsRequest.new

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

# The returned object is of type Google::Cloud::Build::V2::FetchGitRefsResponse.
p result

Overloads:

  • #fetch_git_refs(request, options = nil) ⇒ ::Google::Cloud::Build::V2::FetchGitRefsResponse

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

    Parameters:

    • request (::Google::Cloud::Build::V2::FetchGitRefsRequest, ::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.

  • #fetch_git_refs(repository: nil, ref_type: nil) ⇒ ::Google::Cloud::Build::V2::FetchGitRefsResponse

    Pass arguments to fetch_git_refs 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1574

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::FetchGitRefsRequest

  # 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.fetch_git_refs.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::Build::V2::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.repository
    header_params["repository"] = request.repository
  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.fetch_git_refs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_git_refs.retry_policy

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

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

#fetch_linkable_repositories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository> #fetch_linkable_repositories(connection: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository>

FetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::FetchLinkableRepositoriesRequest.new

# Call the fetch_linkable_repositories method.
result = client.fetch_linkable_repositories 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::Build::V2::Repository.
  p item
end

Overloads:

  • #fetch_linkable_repositories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository>

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

    Parameters:

    • request (::Google::Cloud::Build::V2::FetchLinkableRepositoriesRequest, ::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.

  • #fetch_linkable_repositories(connection: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository>

    Pass arguments to fetch_linkable_repositories 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:

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

      Required. The name of the Connection. Format: projects/*/locations/*/connections/*.

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

      Number of results to return in the list. Default to 20.

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

      Page start.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1484

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::FetchLinkableRepositoriesRequest

  # 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.fetch_linkable_repositories.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::Build::V2::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.connection
    header_params["connection"] = request.connection
  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.fetch_linkable_repositories.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_linkable_repositories.retry_policy

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

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

#fetch_read_token(request, options = nil) ⇒ ::Google::Cloud::Build::V2::FetchReadTokenResponse #fetch_read_token(repository: nil) ⇒ ::Google::Cloud::Build::V2::FetchReadTokenResponse

Fetches read token of a given repository.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::FetchReadTokenRequest.new

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

# The returned object is of type Google::Cloud::Build::V2::FetchReadTokenResponse.
p result

Overloads:

  • #fetch_read_token(request, options = nil) ⇒ ::Google::Cloud::Build::V2::FetchReadTokenResponse

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

    Parameters:

    • request (::Google::Cloud::Build::V2::FetchReadTokenRequest, ::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.

  • #fetch_read_token(repository: nil) ⇒ ::Google::Cloud::Build::V2::FetchReadTokenResponse

    Pass arguments to fetch_read_token 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:

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

      Required. The resource name of the repository in the format projects/*/locations/*/connections/*/repositories/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1389

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::FetchReadTokenRequest

  # 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.fetch_read_token.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::Build::V2::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.repository
    header_params["repository"] = request.repository
  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.fetch_read_token.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_read_token.retry_policy

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

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

#fetch_read_write_token(request, options = nil) ⇒ ::Google::Cloud::Build::V2::FetchReadWriteTokenResponse #fetch_read_write_token(repository: nil) ⇒ ::Google::Cloud::Build::V2::FetchReadWriteTokenResponse

Fetches read/write token of a given repository.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::FetchReadWriteTokenRequest.new

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

# The returned object is of type Google::Cloud::Build::V2::FetchReadWriteTokenResponse.
p result

Overloads:

  • #fetch_read_write_token(request, options = nil) ⇒ ::Google::Cloud::Build::V2::FetchReadWriteTokenResponse

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

    Parameters:

    • request (::Google::Cloud::Build::V2::FetchReadWriteTokenRequest, ::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.

  • #fetch_read_write_token(repository: nil) ⇒ ::Google::Cloud::Build::V2::FetchReadWriteTokenResponse

    Pass arguments to fetch_read_write_token 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:

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

      Required. The resource name of the repository in the format projects/*/locations/*/connections/*/repositories/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1303

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::FetchReadWriteTokenRequest

  # 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.fetch_read_write_token.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::Build::V2::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.repository
    header_params["repository"] = request.repository
  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.fetch_read_write_token.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_read_write_token.retry_policy

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

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

#get_connection(request, options = nil) ⇒ ::Google::Cloud::Build::V2::Connection #get_connection(name: nil) ⇒ ::Google::Cloud::Build::V2::Connection

Gets details of a single connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::GetConnectionRequest.new

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

# The returned object is of type Google::Cloud::Build::V2::Connection.
p result

Overloads:

  • #get_connection(request, options = nil) ⇒ ::Google::Cloud::Build::V2::Connection

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

    Parameters:

    • request (::Google::Cloud::Build::V2::GetConnectionRequest, ::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_connection(name: nil) ⇒ ::Google::Cloud::Build::V2::Connection

    Pass arguments to get_connection 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 name of the Connection to retrieve. Format: projects/*/locations/*/connections/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 424

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::GetConnectionRequest

  # 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_connection.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::Build::V2::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_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_connection.retry_policy

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

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

#get_repository(request, options = nil) ⇒ ::Google::Cloud::Build::V2::Repository #get_repository(name: nil) ⇒ ::Google::Cloud::Build::V2::Repository

Gets details of a single repository.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::GetRepositoryRequest.new

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

# The returned object is of type Google::Cloud::Build::V2::Repository.
p result

Overloads:

  • #get_repository(request, options = nil) ⇒ ::Google::Cloud::Build::V2::Repository

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

    Parameters:

    • request (::Google::Cloud::Build::V2::GetRepositoryRequest, ::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_repository(name: nil) ⇒ ::Google::Cloud::Build::V2::Repository

    Pass arguments to get_repository 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 name of the Repository to retrieve. Format: projects/*/locations/*/connections/*/repositories/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1015

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::GetRepositoryRequest

  # 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_repository.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::Build::V2::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_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_repository.retry_policy

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

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

#list_connections(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Connection> #list_connections(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Connection>

Lists Connections in a given project and location.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::ListConnectionsRequest.new

# Call the list_connections method.
result = client.list_connections 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::Build::V2::Connection.
  p item
end

Overloads:

  • #list_connections(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Connection>

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

    Parameters:

    • request (::Google::Cloud::Build::V2::ListConnectionsRequest, ::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_connections(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Connection>

    Pass arguments to list_connections 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 parent, which owns this collection of Connections. Format: projects/*/locations/*.

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

      Number of results to return in the list.

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

      Page start.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 518

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::ListConnectionsRequest

  # 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_connections.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::Build::V2::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_connections.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_connections.retry_policy

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

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

#list_repositories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository> #list_repositories(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository>

Lists Repositories in a given connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::ListRepositoriesRequest.new

# Call the list_repositories method.
result = client.list_repositories 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::Build::V2::Repository.
  p item
end

Overloads:

  • #list_repositories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository>

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

    Parameters:

    • request (::Google::Cloud::Build::V2::ListRepositoriesRequest, ::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_repositories(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Build::V2::Repository>

    Pass arguments to list_repositories 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 parent, which owns this collection of Repositories. Format: projects/*/locations/*/connections/*.

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

      Number of results to return in the list.

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

      Page start.

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

      A filter expression that filters resources listed in the response. Expressions must follow API improvement proposal AIP-160. e.g. remote_uri:"https://github.com*".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 1114

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::ListRepositoriesRequest

  # 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_repositories.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::Build::V2::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_repositories.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_repositories.retry_policy

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

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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


271
272
273
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 271

def logger
  @repository_manager_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


151
152
153
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 151

def universe_domain
  @repository_manager_stub.universe_domain
end

#update_connection(request, options = nil) ⇒ ::Gapic::Operation #update_connection(connection: nil, update_mask: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Updates a single connection.

Examples:

Basic example

require "google/cloud/build/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Build::V2::RepositoryManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Build::V2::UpdateConnectionRequest.new

# Call the update_connection method.
result = client.update_connection 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_connection(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Build::V2::UpdateConnectionRequest, ::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_connection(connection: nil, update_mask: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_connection 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:

    • connection (::Google::Cloud::Build::V2::Connection, ::Hash) (defaults to: nil) —

      Required. The Connection to update.

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

      The list of fields to be updated.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true, and the connection is not found a new connection will be created. In this situation update_mask is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties).

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

      The current etag of the connection. If an etag is provided and does not match the current etag of the connection, update will be blocked and an ABORTED error will be returned.

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.



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/google/cloud/build/v2/repository_manager/client.rb', line 624

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V2::UpdateConnectionRequest

  # 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_connection.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::Build::V2::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.connection&.name
    header_params["connection.name"] = request.connection.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_connection.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_connection.retry_policy

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

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