Class: Google::Apis::ParametermanagerV1::ParameterManagerService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::ParametermanagerV1::ParameterManagerService
- Defined in:
- lib/google/apis/parametermanager_v1/service.rb
Overview
Parameter Manager API
Parameter Manager is a single source of truth to store, access and manage the lifecycle of your workload parameters. Parameter Manager aims to make management of sensitive application parameters effortless for customers without diminishing focus on security.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://parametermanager.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#create_project_location_parameter(parent, parameter_object = nil, parameter_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Parameter
Creates a new Parameter in a given project and location.
-
#create_project_location_parameter_version(parent, parameter_version_object = nil, parameter_version_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ParameterVersion
Creates a new ParameterVersion in a given project, location, and parameter.
-
#delete_project_location_parameter(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Empty
Deletes a single Parameter.
-
#delete_project_location_parameter_version(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Empty
Deletes a single ParameterVersion.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Location
Gets information about a location.
-
#get_project_location_parameter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Parameter
Gets details of a single Parameter.
-
#get_project_location_parameter_version(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ParameterVersion
Gets details of a single ParameterVersion.
-
#initialize ⇒ ParameterManagerService
constructor
A new instance of ParameterManagerService.
-
#list_project_location_parameter_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ListParameterVersionsResponse
Lists ParameterVersions in a given project, location, and parameter.
-
#list_project_location_parameters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ListParametersResponse
Lists Parameters in a given project and location.
-
#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ListLocationsResponse
Lists information about the supported locations for this service.
-
#patch_project_location_parameter(name, parameter_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Parameter
Updates a single Parameter.
-
#patch_project_location_parameter_version(name, parameter_version_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ParameterVersion
Updates a single ParameterVersion.
-
#render_project_location_parameter_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::RenderParameterVersionResponse
Gets rendered version of a ParameterVersion.
Constructor Details
#initialize ⇒ ParameterManagerService
Returns a new instance of ParameterManagerService.
50 51 52 53 54 55 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 50 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-parametermanager_v1', client_version: Google::Apis::ParametermanagerV1::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
43 44 45 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 43 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
48 49 50 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 48 def quota_user @quota_user end |
Instance Method Details
#create_project_location_parameter(parent, parameter_object = nil, parameter_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Parameter
Creates a new Parameter in a given project and location.
168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 168 def create_project_location_parameter(parent, parameter_object = nil, parameter_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/parameters', ) command.request_representation = Google::Apis::ParametermanagerV1::Parameter::Representation command.request_object = parameter_object command.response_representation = Google::Apis::ParametermanagerV1::Parameter::Representation command.response_class = Google::Apis::ParametermanagerV1::Parameter command.params['parent'] = parent unless parent.nil? command.query['parameterId'] = parameter_id unless parameter_id.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_parameter_version(parent, parameter_version_object = nil, parameter_version_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ParameterVersion
Creates a new ParameterVersion in a given project, location, and parameter.
387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 387 def create_project_location_parameter_version(parent, parameter_version_object = nil, parameter_version_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/versions', ) command.request_representation = Google::Apis::ParametermanagerV1::ParameterVersion::Representation command.request_object = parameter_version_object command.response_representation = Google::Apis::ParametermanagerV1::ParameterVersion::Representation command.response_class = Google::Apis::ParametermanagerV1::ParameterVersion command.params['parent'] = parent unless parent.nil? command.query['parameterVersionId'] = parameter_version_id unless parameter_version_id.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_parameter(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Empty
Deletes a single Parameter.
214 215 216 217 218 219 220 221 222 223 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 214 def delete_project_location_parameter(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::ParametermanagerV1::Empty::Representation command.response_class = Google::Apis::ParametermanagerV1::Empty command.params['name'] = name unless name.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_parameter_version(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Empty
Deletes a single ParameterVersion.
433 434 435 436 437 438 439 440 441 442 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 433 def delete_project_location_parameter_version(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::ParametermanagerV1::Empty::Representation command.response_class = Google::Apis::ParametermanagerV1::Empty command.params['name'] = name unless name.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Location
Gets information about a location.
77 78 79 80 81 82 83 84 85 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 77 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ParametermanagerV1::Location::Representation command.response_class = Google::Apis::ParametermanagerV1::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_parameter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Parameter
Gets details of a single Parameter.
246 247 248 249 250 251 252 253 254 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 246 def get_project_location_parameter(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ParametermanagerV1::Parameter::Representation command.response_class = Google::Apis::ParametermanagerV1::Parameter command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_parameter_version(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ParameterVersion
Gets details of a single ParameterVersion.
468 469 470 471 472 473 474 475 476 477 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 468 def get_project_location_parameter_version(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ParametermanagerV1::ParameterVersion::Representation command.response_class = Google::Apis::ParametermanagerV1::ParameterVersion command.params['name'] = name unless name.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_parameter_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ListParameterVersionsResponse
Lists ParameterVersions in a given project, location, and parameter.
509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 509 def list_project_location_parameter_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/versions', ) command.response_representation = Google::Apis::ParametermanagerV1::ListParameterVersionsResponse::Representation command.response_class = Google::Apis::ParametermanagerV1::ListParameterVersionsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_parameters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ListParametersResponse
Lists Parameters in a given project and location.
286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 286 def list_project_location_parameters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/parameters', ) command.response_representation = Google::Apis::ParametermanagerV1::ListParametersResponse::Representation command.response_class = Google::Apis::ParametermanagerV1::ListParametersResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ListLocationsResponse
Lists information about the supported locations for this service.
120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 120 def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/locations', ) command.response_representation = Google::Apis::ParametermanagerV1::ListLocationsResponse::Representation command.response_class = Google::Apis::ParametermanagerV1::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_parameter(name, parameter_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::Parameter
Updates a single Parameter.
339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 339 def patch_project_location_parameter(name, parameter_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::ParametermanagerV1::Parameter::Representation command.request_object = parameter_object command.response_representation = Google::Apis::ParametermanagerV1::Parameter::Representation command.response_class = Google::Apis::ParametermanagerV1::Parameter command.params['name'] = name unless name.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_parameter_version(name, parameter_version_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::ParameterVersion
Updates a single ParameterVersion.
562 563 564 565 566 567 568 569 570 571 572 573 574 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 562 def patch_project_location_parameter_version(name, parameter_version_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::ParametermanagerV1::ParameterVersion::Representation command.request_object = parameter_version_object command.response_representation = Google::Apis::ParametermanagerV1::ParameterVersion::Representation command.response_class = Google::Apis::ParametermanagerV1::ParameterVersion command.params['name'] = name unless name.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#render_project_location_parameter_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ParametermanagerV1::RenderParameterVersionResponse
Gets rendered version of a ParameterVersion.
596 597 598 599 600 601 602 603 604 |
# File 'lib/google/apis/parametermanager_v1/service.rb', line 596 def render_project_location_parameter_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}:render', ) command.response_representation = Google::Apis::ParametermanagerV1::RenderParameterVersionResponse::Representation command.response_class = Google::Apis::ParametermanagerV1::RenderParameterVersionResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |