GDC Hardware Management V1ALPHA API - Class Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client (v0.5.0)

Reference documentation and code samples for the GDC Hardware Management V1ALPHA API class Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.

REST client for the GDCHardwareManagement service.

The GDC Hardware Management service.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the GDCHardwareManagement Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all GDCHardwareManagement clients
::Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the GDCHardwareManagement 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_comment

def create_comment(request, options = nil) -> ::Gapic::Operation
def create_comment(parent: nil, comment_id: nil, comment: nil, request_id: nil) -> ::Gapic::Operation

Creates a new comment on an order.

Overloads 
def create_comment(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_comment via a request object, either of type CreateCommentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::CreateCommentRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_comment(parent: nil, comment_id: nil, comment: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_comment 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) — Required. The order to create the comment on. Format: projects/{project}/locations/{location}/orders/{order}
  • comment_id (::String) — Optional. ID used to uniquely identify the Comment within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

    The comment.name field in the request will be ignored.

  • comment (::Google::Cloud::GDCHardwareManagement::V1alpha::Comment, ::Hash) — Required. The comment to create.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::CreateCommentRequest.new

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

#create_hardware

def create_hardware(request, options = nil) -> ::Gapic::Operation
def create_hardware(parent: nil, hardware_id: nil, hardware: nil) -> ::Gapic::Operation

Creates new hardware in a given project and location.

Overloads 
def create_hardware(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_hardware via a request object, either of type CreateHardwareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::CreateHardwareRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_hardware(parent: nil, hardware_id: nil, hardware: nil) -> ::Gapic::Operation
Pass arguments to create_hardware 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) — Required. The project and location to create hardware in. Format: projects/{project}/locations/{location}
  • hardware_id (::String) — Optional. ID used to uniquely identify the Hardware within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

    The hardware.name field in the request will be ignored.

  • hardware (::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware, ::Hash) — Required. The resource to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::CreateHardwareRequest.new

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

#create_hardware_group

def create_hardware_group(request, options = nil) -> ::Gapic::Operation
def create_hardware_group(parent: nil, hardware_group_id: nil, hardware_group: nil, request_id: nil) -> ::Gapic::Operation

Creates a new hardware group in a given order.

Overloads 
def create_hardware_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_hardware_group via a request object, either of type CreateHardwareGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::CreateHardwareGroupRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_hardware_group(parent: nil, hardware_group_id: nil, hardware_group: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_hardware_group 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) — Required. The order to create the hardware group in. Format: projects/{project}/locations/{location}/orders/{order}
  • hardware_group_id (::String) — Optional. ID used to uniquely identify the HardwareGroup within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

    The hardware_group.name field in the request will be ignored.

  • hardware_group (::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup, ::Hash) — Required. The hardware group to create.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::CreateHardwareGroupRequest.new

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

#create_order

def create_order(request, options = nil) -> ::Gapic::Operation
def create_order(parent: nil, order_id: nil, order: nil, request_id: nil) -> ::Gapic::Operation

Creates a new order in a given project and location.

Overloads 
def create_order(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_order via a request object, either of type CreateOrderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::CreateOrderRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_order(parent: nil, order_id: nil, order: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_order 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) — Required. The project and location to create the order in. Format: projects/{project}/locations/{location}
  • order_id (::String) — Optional. ID used to uniquely identify the Order within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

    The order.name field in the request will be ignored.

  • order (::Google::Cloud::GDCHardwareManagement::V1alpha::Order, ::Hash) — Required. The order to create.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::CreateOrderRequest.new

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

#create_site

def create_site(request, options = nil) -> ::Gapic::Operation
def create_site(parent: nil, site_id: nil, site: nil, request_id: nil) -> ::Gapic::Operation

Creates a new site in a given project and location.

Overloads 
def create_site(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_site via a request object, either of type CreateSiteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::CreateSiteRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_site(parent: nil, site_id: nil, site: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_site 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) — Required. The project and location to create the site in. Format: projects/{project}/locations/{location}
  • site_id (::String) — Optional. ID used to uniquely identify the Site within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

    The site.name field in the request will be ignored.

  • site (::Google::Cloud::GDCHardwareManagement::V1alpha::Site, ::Hash) — Required. The site to create.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::CreateSiteRequest.new

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

#create_zone

def create_zone(request, options = nil) -> ::Gapic::Operation
def create_zone(parent: nil, zone_id: nil, zone: nil, request_id: nil) -> ::Gapic::Operation

Creates a new zone in a given project and location.

Overloads 
def create_zone(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_zone via a request object, either of type CreateZoneRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::CreateZoneRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_zone(parent: nil, zone_id: nil, zone: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_zone 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) — Required. The project and location to create the zone in. Format: projects/{project}/locations/{location}
  • zone_id (::String) — Optional. ID used to uniquely identify the Zone within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and - are accepted. The - character cannot be the first or the last one. A system generated ID will be used if the field is not set.

    The zone.name field in the request will be ignored.

  • zone (::Google::Cloud::GDCHardwareManagement::V1alpha::Zone, ::Hash) — Required. The zone to create.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::CreateZoneRequest.new

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

#delete_hardware

def delete_hardware(request, options = nil) -> ::Gapic::Operation
def delete_hardware(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes hardware.

Overloads 
def delete_hardware(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_hardware via a request object, either of type DeleteHardwareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::DeleteHardwareRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_hardware(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_hardware 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) — Required. The name of the hardware. Format: projects/{project}/locations/{location}/hardware/{hardware}
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::DeleteHardwareRequest.new

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

#delete_hardware_group

def delete_hardware_group(request, options = nil) -> ::Gapic::Operation
def delete_hardware_group(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a hardware group.

Overloads 
def delete_hardware_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_hardware_group via a request object, either of type DeleteHardwareGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::DeleteHardwareGroupRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_hardware_group(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_hardware_group 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) — Required. The name of the hardware group. Format: projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::DeleteHardwareGroupRequest.new

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

#delete_order

def delete_order(request, options = nil) -> ::Gapic::Operation
def delete_order(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation

Deletes an order.

Overloads 
def delete_order(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_order via a request object, either of type DeleteOrderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::DeleteOrderRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_order(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_order 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) — Required. The name of the order. Format: projects/{project}/locations/{location}/orders/{order}
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
  • force (::Boolean) — Optional. An option to delete any nested resources in the Order, such as a HardwareGroup. If true, any nested resources for this Order will also be deleted. Otherwise, the request will only succeed if the Order has no nested resources.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::DeleteOrderRequest.new

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

#delete_site

def delete_site(request, options = nil) -> ::Gapic::Operation
def delete_site(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a site.

Overloads 
def delete_site(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_site via a request object, either of type DeleteSiteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::DeleteSiteRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_site(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_site 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) — Required. The name of the site. Format: projects/{project}/locations/{location}/sites/{site}
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::DeleteSiteRequest.new

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

#delete_zone

def delete_zone(request, options = nil) -> ::Gapic::Operation
def delete_zone(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a zone.

Overloads 
def delete_zone(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_zone via a request object, either of type DeleteZoneRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::DeleteZoneRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_zone(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_zone 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) — Required. The name of the zone. Format: projects/{project}/locations/{location}/zones/{zone}
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::DeleteZoneRequest.new

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

#get_change_log_entry

def get_change_log_entry(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ChangeLogEntry
def get_change_log_entry(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ChangeLogEntry

Gets details of a change to an order.

Overloads 
def get_change_log_entry(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ChangeLogEntry
Pass arguments to get_change_log_entry via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetChangeLogEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetChangeLogEntryRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_change_log_entry(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ChangeLogEntry
Pass arguments to get_change_log_entry 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).
Parameter
  • name (::String) — Required. The name of the change log entry. Format: projects/{project}/locations/{location}/orders/{order}/changeLogEntries/{change_log_entry}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetChangeLogEntryRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::ChangeLogEntry.
p result

#get_comment

def get_comment(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment
def get_comment(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment

Gets the content of a comment.

Overloads 
def get_comment(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment
Pass arguments to get_comment via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetCommentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetCommentRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_comment(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment
Pass arguments to get_comment 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).
Parameter
  • name (::String) — Required. The name of the comment. Format: projects/{project}/locations/{location}/orders/{order}/comments/{comment}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetCommentRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Comment.
p result

#get_hardware

def get_hardware(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware
def get_hardware(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware

Gets hardware details.

Overloads 
def get_hardware(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware
Pass arguments to get_hardware via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetHardwareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetHardwareRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_hardware(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware
Pass arguments to get_hardware 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).
Parameter
  • name (::String) — Required. The name of the hardware. Format: projects/{project}/locations/{location}/hardware/{hardware}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetHardwareRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Hardware.
p result

#get_hardware_group

def get_hardware_group(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup
def get_hardware_group(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup

Gets details of a hardware group.

Overloads 
def get_hardware_group(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup
Pass arguments to get_hardware_group via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetHardwareGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetHardwareGroupRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_hardware_group(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup
Pass arguments to get_hardware_group 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).
Parameter
  • name (::String) — Required. The name of the hardware group. Format: projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetHardwareGroupRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup.
p result

#get_order

def get_order(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Order
def get_order(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Order

Gets details of an order.

Overloads 
def get_order(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Order
Pass arguments to get_order via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetOrderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetOrderRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_order(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Order
Pass arguments to get_order 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).
Parameter
  • name (::String) — Required. Name of the resource
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetOrderRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Order.
p result

#get_site

def get_site(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Site
def get_site(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Site

Gets details of a site.

Overloads 
def get_site(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Site
Pass arguments to get_site via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetSiteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetSiteRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_site(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Site
Pass arguments to get_site 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).
Parameter
  • name (::String) — Required. The name of the site. Format: projects/{project}/locations/{location}/sites/{site}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetSiteRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Site.
p result

#get_sku

def get_sku(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Sku
def get_sku(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Sku

Gets details of an SKU.

Overloads 
def get_sku(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Sku
Pass arguments to get_sku via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetSkuRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetSkuRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_sku(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Sku
Pass arguments to get_sku 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).
Parameter
  • name (::String) — Required. The name of the SKU. Format: projects/{project}/locations/{location}/skus/{sku}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetSkuRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Sku.
p result

#get_zone

def get_zone(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Zone
def get_zone(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Zone

Gets details of a zone.

Overloads 
def get_zone(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Zone
Pass arguments to get_zone via a request object, either of type Google::Cloud::GDCHardwareManagement::V1alpha::GetZoneRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::GetZoneRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_zone(name: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Zone
Pass arguments to get_zone 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).
Parameter
  • name (::String) — Required. The name of the zone. Format: projects/{project}/locations/{location}/zones/{zone}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::GetZoneRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Zone.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new GDCHardwareManagement REST client object.

Yields
  • (config) — Configure the GDCHardwareManagement client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_change_log_entries

def list_change_log_entries(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListChangeLogEntriesResponse
def list_change_log_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListChangeLogEntriesResponse

Lists the changes made to an order.

Overloads 
def list_change_log_entries(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListChangeLogEntriesResponse
Pass arguments to list_change_log_entries via a request object, either of type ListChangeLogEntriesRequest or an equivalent Hash.
Parameters 
def list_change_log_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListChangeLogEntriesResponse
Pass arguments to list_change_log_entries 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) — Required. The order to list change log entries for. Format: projects/{project}/locations/{location}/orders/{order}
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListChangeLogEntriesRequest.new

# Call the list_change_log_entries method.
result = client.list_change_log_entries 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::GDCHardwareManagement::V1alpha::ChangeLogEntry.
  p item
end

#list_comments

def list_comments(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListCommentsResponse
def list_comments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListCommentsResponse

Lists the comments on an order.

Overloads 
def list_comments(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListCommentsResponse
Pass arguments to list_comments via a request object, either of type ListCommentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListCommentsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_comments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListCommentsResponse
Pass arguments to list_comments 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) — Required. The order to list comments on. Format: projects/{project}/locations/{location}/orders/{order}
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListCommentsRequest.new

# Call the list_comments method.
result = client.list_comments 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::GDCHardwareManagement::V1alpha::Comment.
  p item
end

#list_hardware

def list_hardware(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareResponse
def list_hardware(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareResponse

Lists hardware in a given project and location.

Overloads 
def list_hardware(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareResponse
Pass arguments to list_hardware via a request object, either of type ListHardwareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_hardware(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareResponse
Pass arguments to list_hardware 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) — Required. The project and location to list hardware in. Format: projects/{project}/locations/{location}

    To list hardware across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareRequest.new

# Call the list_hardware method.
result = client.list_hardware 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::GDCHardwareManagement::V1alpha::Hardware.
  p item
end

#list_hardware_groups

def list_hardware_groups(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareGroupsResponse
def list_hardware_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareGroupsResponse

Lists hardware groups in a given order.

Overloads 
def list_hardware_groups(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareGroupsResponse
Pass arguments to list_hardware_groups via a request object, either of type ListHardwareGroupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareGroupsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_hardware_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareGroupsResponse
Pass arguments to list_hardware_groups 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) — Required. The order to list hardware groups in. Format: projects/{project}/locations/{location}/orders/{order}
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListHardwareGroupsRequest.new

# Call the list_hardware_groups method.
result = client.list_hardware_groups 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::GDCHardwareManagement::V1alpha::HardwareGroup.
  p item
end

#list_orders

def list_orders(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListOrdersResponse
def list_orders(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListOrdersResponse

Lists orders in a given project and location.

Overloads 
def list_orders(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListOrdersResponse
Pass arguments to list_orders via a request object, either of type ListOrdersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListOrdersRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_orders(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListOrdersResponse
Pass arguments to list_orders 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) — Required. The project and location to list orders in. Format: projects/{project}/locations/{location}

    To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListOrdersRequest.new

# Call the list_orders method.
result = client.list_orders 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::GDCHardwareManagement::V1alpha::Order.
  p item
end

#list_sites

def list_sites(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSitesResponse
def list_sites(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSitesResponse

Lists sites in a given project and location.

Overloads 
def list_sites(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSitesResponse
Pass arguments to list_sites via a request object, either of type ListSitesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListSitesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_sites(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSitesResponse
Pass arguments to list_sites 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) — Required. The project and location to list sites in. Format: projects/{project}/locations/{location}

    To list sites across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListSitesRequest.new

# Call the list_sites method.
result = client.list_sites 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::GDCHardwareManagement::V1alpha::Site.
  p item
end

#list_skus

def list_skus(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSkusResponse
def list_skus(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSkusResponse

Lists SKUs for a given project and location.

Overloads 
def list_skus(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSkusResponse
Pass arguments to list_skus via a request object, either of type ListSkusRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListSkusRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_skus(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListSkusResponse
Pass arguments to list_skus 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) — Required. The project and location to list SKUs in. Format: projects/{project}/locations/{location}

    To list SKUs across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListSkusRequest.new

# Call the list_skus method.
result = client.list_skus 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::GDCHardwareManagement::V1alpha::Sku.
  p item
end

#list_zones

def list_zones(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListZonesResponse
def list_zones(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListZonesResponse

Lists zones in a given project and location.

Overloads 
def list_zones(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListZonesResponse
Pass arguments to list_zones via a request object, either of type ListZonesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::ListZonesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_zones(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::ListZonesResponse
Pass arguments to list_zones 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) — Required. The project and location to list zones in. Format: projects/{project}/locations/{location}

    To list zones across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering condition. See AIP-160.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::ListZonesRequest.new

# Call the list_zones method.
result = client.list_zones 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::GDCHardwareManagement::V1alpha::Zone.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Operations

Get the associated client for long-running operations.

Returns

#record_action_on_comment

def record_action_on_comment(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment
def record_action_on_comment(name: nil, action_type: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment

Record Action on a Comment. If the Action specified in the request is READ, the viewed time in the comment is set to the time the request was received. If the comment is already marked as read, subsequent calls will be ignored. If the Action is UNREAD, the viewed time is cleared from the comment.

Overloads 
def record_action_on_comment(request, options = nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment
Pass arguments to record_action_on_comment via a request object, either of type RecordActionOnCommentRequest or an equivalent Hash.
Parameters 
def record_action_on_comment(name: nil, action_type: nil) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::Comment
Pass arguments to record_action_on_comment 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::RecordActionOnCommentRequest.new

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

# The returned object is of type Google::Cloud::GDCHardwareManagement::V1alpha::Comment.
p result

#signal_zone_state

def signal_zone_state(request, options = nil) -> ::Gapic::Operation
def signal_zone_state(name: nil, request_id: nil, state_signal: nil, provisioning_state_signal: nil) -> ::Gapic::Operation

Signals the state of a zone.

Overloads 
def signal_zone_state(request, options = nil) -> ::Gapic::Operation
Pass arguments to signal_zone_state via a request object, either of type SignalZoneStateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::SignalZoneStateRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def signal_zone_state(name: nil, request_id: nil, state_signal: nil, provisioning_state_signal: nil) -> ::Gapic::Operation
Pass arguments to signal_zone_state 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::SignalZoneStateRequest.new

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

#submit_order

def submit_order(request, options = nil) -> ::Gapic::Operation
def submit_order(name: nil, request_id: nil, type: nil) -> ::Gapic::Operation

Submits an order.

Overloads 
def submit_order(request, options = nil) -> ::Gapic::Operation
Pass arguments to submit_order via a request object, either of type SubmitOrderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::SubmitOrderRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def submit_order(name: nil, request_id: nil, type: nil) -> ::Gapic::Operation
Pass arguments to submit_order 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::SubmitOrderRequest.new

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_hardware

def update_hardware(request, options = nil) -> ::Gapic::Operation
def update_hardware(update_mask: nil, hardware: nil, request_id: nil) -> ::Gapic::Operation

Updates hardware parameters.

Overloads 
def update_hardware(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_hardware via a request object, either of type UpdateHardwareRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::UpdateHardwareRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_hardware(update_mask: nil, hardware: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_hardware via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A mask to specify the fields in the Hardware to overwrite with this update. The fields specified in the update_mask are relative to the hardware, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
  • hardware (::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware, ::Hash) — Required. The hardware to update.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::UpdateHardwareRequest.new

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

#update_hardware_group

def update_hardware_group(request, options = nil) -> ::Gapic::Operation
def update_hardware_group(update_mask: nil, hardware_group: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a hardware group.

Overloads 
def update_hardware_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_hardware_group via a request object, either of type UpdateHardwareGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::UpdateHardwareGroupRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_hardware_group(update_mask: nil, hardware_group: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_hardware_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A mask to specify the fields in the HardwareGroup to overwrite with this update. The fields specified in the update_mask are relative to the hardware group, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
  • hardware_group (::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup, ::Hash) — Required. The hardware group to update.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::UpdateHardwareGroupRequest.new

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

#update_order

def update_order(request, options = nil) -> ::Gapic::Operation
def update_order(update_mask: nil, order: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of an order.

Overloads 
def update_order(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_order via a request object, either of type UpdateOrderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::UpdateOrderRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_order(update_mask: nil, order: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_order via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A mask to specify the fields in the Order to overwrite with this update. The fields specified in the update_mask are relative to the order, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
  • order (::Google::Cloud::GDCHardwareManagement::V1alpha::Order, ::Hash) — Required. The order to update.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::UpdateOrderRequest.new

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

#update_site

def update_site(request, options = nil) -> ::Gapic::Operation
def update_site(update_mask: nil, site: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a site.

Overloads 
def update_site(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_site via a request object, either of type UpdateSiteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::UpdateSiteRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_site(update_mask: nil, site: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_site via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A mask to specify the fields in the Site to overwrite with this update. The fields specified in the update_mask are relative to the site, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
  • site (::Google::Cloud::GDCHardwareManagement::V1alpha::Site, ::Hash) — Required. The site to update.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::UpdateSiteRequest.new

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

#update_zone

def update_zone(request, options = nil) -> ::Gapic::Operation
def update_zone(update_mask: nil, zone: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a zone.

Overloads 
def update_zone(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_zone via a request object, either of type UpdateZoneRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GDCHardwareManagement::V1alpha::UpdateZoneRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_zone(update_mask: nil, zone: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_zone via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. A mask to specify the fields in the Zone to overwrite with this update. The fields specified in the update_mask are relative to the zone, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask then all fields will be overwritten.
  • zone (::Google::Cloud::GDCHardwareManagement::V1alpha::Zone, ::Hash) — Required. The zone to update.
  • request_id (::String) — Optional. An optional unique identifier for this request. See AIP-155.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gdc_hardware_management/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GDCHardwareManagement::V1alpha::GDCHardwareManagement::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GDCHardwareManagement::V1alpha::UpdateZoneRequest.new

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