Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::LicenseCodes::Rest::Client.
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.
- (config) — Configure the Client client.
- config (Client::Configuration)
# 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.
- (config) — Configure the Client client.
- config (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.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::LicenseCode
get
via a request object, either of type
GetLicenseCodeRequest or an equivalent Hash.
- 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.
def get(license_code: nil, project: nil) -> ::Google::Cloud::Compute::V1::LicenseCode
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).
- license_code (::String) — Number corresponding to the License code resource to return.
- project (::String) — Project ID for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Compute::V1::LicenseCode)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::LicenseCodes::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::GetLicenseCodeRequest.new # Call the get method. result = client.get request # The returned object is of type Google::Cloud::Compute::V1::LicenseCode. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new LicenseCodes REST client object.
- (config) — Configure the LicenseCodes client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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.
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
via a request object, either of type
TestIamPermissionsLicenseCodeRequest or an equivalent Hash.
- 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.
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
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).
- 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
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::LicenseCodes::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::TestIamPermissionsLicenseCodeRequest.new # Call the test_iam_permissions method. result = client.test_iam_permissions request # The returned object is of type Google::Cloud::Compute::V1::TestPermissionsResponse. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)