Class Google::Cloud::Compute::V1::LicenseCodes::Rest::Client (v1.1.0)

REST client for the LicenseCodes service.

The LicenseCodes API.

Inherits

Object

Methods

.configure

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

Configure the LicenseCodes Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

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

Configure the LicenseCodes 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

config (Client::Configuration)

Returns

(Client::Configuration)

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::LicenseCode
def get(license_code: nil, project: nil) -> ::Google::Cloud::Compute::V1::LicenseCode

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Overloads

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::LicenseCode

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

Parameters

request (::Google::Cloud::Compute::V1::GetLicenseCodeRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def get(license_code: nil, project: nil) -> ::Google::Cloud::Compute::V1::LicenseCode

Pass arguments to get 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

license_code (::String) — Number corresponding to the License code resource to return.
project (::String) — Project ID for this request.

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Google::Cloud::Compute::V1::LicenseCode)
response (::Faraday::Response)

Returns

(::Google::Cloud::Compute::V1::LicenseCode)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#initialize

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

Create a new LicenseCodes REST client object.

Yields

(config) — Configure the LicenseCodes client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::LicenseCodes::Rest::Client.new

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

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Returns permissions that a caller has on the specified resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Overloads

def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

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

Parameters

request (::Google::Cloud::Compute::V1::TestIamPermissionsLicenseCodeRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Pass arguments to test_iam_permissions 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

project (::String) — Project ID for this request.
resource (::String) — Name or id of the resource for this request.
test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) — The body resource for this request

Yields

(result, response) — Access the result along with the Faraday response object

Yield Parameters

result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
response (::Faraday::Response)

Returns

(::Google::Cloud::Compute::V1::TestPermissionsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.