activate_certificate_authority(name, activate_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Activate a CertificateAuthority
that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate
Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process. @param [String] name
Required. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::ActivateCertificateAuthorityRequest] activate_certificate_authority_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def activate_certificate_authority(name, activate_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:activate', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::ActivateCertificateAuthorityRequest::Representation
command.request_object = activate_certificate_authority_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error
value with a google.rpc.Status.code
of 1, corresponding to `Code.CANCELLED`. @param [String] name
The name of the operation resource to be cancelled.
@param [Google::Apis::PrivatecaV1beta1::CancelOperationRequest] cancel_operation_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::CancelOperationRequest::Representation
command.request_object = cancel_operation_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Empty::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
create_project_location_certificate_authority(parent, certificate_authority_object = nil, certificate_authority_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Create a new CertificateAuthority
in a given Project and Location
. @param [String] parent
Required. The resource name of the location associated with the
CertificateAuthorities, in the format `projects/*/locations/*`.
@param [Google::Apis::PrivatecaV1beta1::CertificateAuthority] certificate_authority_object @param [String] certificate_authority_id
Required. It must be unique within a location and match the regular expression
`[a-zA-Z0-9_-]`1,63``
@param [String] request_id
Optional. An ID to identify requests. Specify a unique request ID so that if
you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request. For example, consider a situation where you
make an initial request and t he request times out. If you make the request
again with the same request ID, the server can check if original operation
with the same request ID was received, and if so, will ignore the second
request. This prevents clients from accidentally creating duplicate
commitments. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_certificate_authority(parent, certificate_authority_object = nil, certificate_authority_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/certificateAuthorities', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::CertificateAuthority::Representation
command.request_object = certificate_authority_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['certificateAuthorityId'] = certificate_authority_id unless certificate_authority_id.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
create_project_location_certificate_authority_certificate(parent, certificate_object = nil, certificate_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Create a new Certificate
in a given Project, Location
from a particular CertificateAuthority
. @param [String] parent
Required. The resource name of the location and CertificateAuthority
associated with the Certificate, in the format `projects/*/locations/*/
certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::Certificate] certificate_object @param [String] certificate_id
Optional. It must be unique within a location and match the regular expression
`[a-zA-Z0-9_-]`1,63``. This field is required when using a
CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is
optional and its value is ignored otherwise.
@param [String] request_id
Optional. An ID to identify requests. Specify a unique request ID so that if
you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request. For example, consider a situation where you
make an initial request and t he request times out. If you make the request
again with the same request ID, the server can check if original operation
with the same request ID was received, and if so, will ignore the second
request. This prevents clients from accidentally creating duplicate
commitments. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Certificate] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Certificate]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_certificate_authority_certificate(parent, certificate_object = nil, certificate_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/certificates', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::Certificate::Representation
command.request_object = certificate_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Certificate::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Certificate
command.params['parent'] = parent unless parent.nil?
command.query['certificateId'] = certificate_id unless certificate_id.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code. UNIMPLEMENTED`. @param [String] name
The name of the operation resource to be deleted.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Empty::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
disable_certificate_authority(name, disable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Disable a CertificateAuthority
. @param [String] name
Required. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::DisableCertificateAuthorityRequest] disable_certificate_authority_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def disable_certificate_authority(name, disable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:disable', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::DisableCertificateAuthorityRequest::Representation
command.request_object = disable_certificate_authority_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
enable_certificate_authority(name, enable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Enable a CertificateAuthority
. @param [String] name
Required. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::EnableCertificateAuthorityRequest] enable_certificate_authority_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def enable_certificate_authority(name, enable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:enable', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::EnableCertificateAuthorityRequest::Representation
command.request_object = enable_certificate_authority_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
fetch_project_location_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Fetch a certificate signing request (CSR) from a CertificateAuthority
that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate
Authority, which could be another CertificateAuthority
resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority. @param [String] name
Required. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::FetchCertificateAuthorityCsrResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::FetchCertificateAuthorityCsrResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def fetch_project_location_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}:fetch', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::FetchCertificateAuthorityCsrResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::FetchCertificateAuthorityCsrResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Gets information about a location. @param [String] name
Resource name for the location.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Location] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Location]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Location::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Location
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns a CertificateAuthority
. @param [String] name
Required. The name of the CertificateAuthority to get.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::CertificateAuthority] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::CertificateAuthority]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::CertificateAuthority::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::CertificateAuthority
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_certificate_authority_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns a Certificate
. @param [String] name
Required. The name of the Certificate to get.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Certificate] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Certificate]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_certificate_authority_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Certificate::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Certificate
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_certificate_authority_certificate_revocation_list(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns a CertificateRevocationList
. @param [String] name
Required. The name of the CertificateRevocationList to get.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::CertificateRevocationList] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::CertificateRevocationList]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_certificate_authority_certificate_revocation_list(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::CertificateRevocationList::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::CertificateRevocationList
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_certificate_authority_certificate_revocation_list_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and
3. Requests specifying an invalid value will be rejected. Requests for
policies with any conditional bindings must specify version 3. Policies
without any conditional bindings may specify any valid value or leave the
field unset. To learn which resources support conditions in their IAM policies,
see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
resource-policies).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_certificate_authority_certificate_revocation_list_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Policy::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_certificate_authority_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and
3. Requests specifying an invalid value will be rejected. Requests for
policies with any conditional bindings must specify version 3. Policies
without any conditional bindings may specify any valid value or leave the
field unset. To learn which resources support conditions in their IAM policies,
see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
resource-policies).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_certificate_authority_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Policy::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. @param [String] name
The name of the operation resource.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_reusable_config(name, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns a ReusableConfig
. @param [String] name
Required. The name of the ReusableConfigs to get.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ReusableConfig] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ReusableConfig]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_reusable_config(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ReusableConfig::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ReusableConfig
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
get_project_location_reusable_config_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and
3. Requests specifying an invalid value will be rejected. Requests for
policies with any conditional bindings must specify version 3. Policies
without any conditional bindings may specify any valid value or leave the
field unset. To learn which resources support conditions in their IAM policies,
see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
resource-policies).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_reusable_config_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::Policy::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
list_project_location_certificate_authorities(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Lists CertificateAuthorities. @param [String] parent
Required. The resource name of the location associated with the
CertificateAuthorities, in the format `projects/*/locations/*`.
@param [String] filter
Optional. Only include resources that match the filter in the response.
@param [String] order_by
Optional. Specify how the results should be sorted.
@param [Fixnum] page_size
Optional. Limit on the number of CertificateAuthorities to include in the
response. Further CertificateAuthorities can subsequently be obtained by
including the ListCertificateAuthoritiesResponse.next_page_token in a
subsequent request. If unspecified, the server will pick an appropriate
default.
@param [String] page_token
Optional. Pagination token, returned earlier via
ListCertificateAuthoritiesResponse.next_page_token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ListCertificateAuthoritiesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ListCertificateAuthoritiesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_certificate_authorities(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/certificateAuthorities', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ListCertificateAuthoritiesResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ListCertificateAuthoritiesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
list_project_location_certificate_authority_certificate_revocation_lists(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Lists CertificateRevocationLists. @param [String] parent
Required. The resource name of the location associated with the
CertificateRevocationLists, in the format `projects/*/locations/*/
certificateauthorities/*`.
@param [String] filter
Optional. Only include resources that match the filter in the response.
@param [String] order_by
Optional. Specify how the results should be sorted.
@param [Fixnum] page_size
Optional. Limit on the number of CertificateRevocationLists to include in the
response. Further CertificateRevocationLists can subsequently be obtained by
including the ListCertificateRevocationListsResponse.next_page_token in a
subsequent request. If unspecified, the server will pick an appropriate
default.
@param [String] page_token
Optional. Pagination token, returned earlier via
ListCertificateRevocationListsResponse.next_page_token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ListCertificateRevocationListsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ListCertificateRevocationListsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_certificate_authority_certificate_revocation_lists(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/certificateRevocationLists', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ListCertificateRevocationListsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ListCertificateRevocationListsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
list_project_location_certificate_authority_certificates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Lists Certificates. @param [String] parent
Required. The resource name of the location associated with the Certificates,
in the format `projects/*/locations/*/certificateauthorities/*`.
@param [String] filter
Optional. Only include resources that match the filter in the response. For
details on supported filters and syntax, see [Certificates Filtering
documentation](https://cloud.google.com/certificate-authority-service/docs/
sorting-filtering-certificates#filtering_support).
@param [String] order_by
Optional. Specify how the results should be sorted. For details on supported
fields and syntax, see [Certificates Sorting documentation](https://cloud.
google.com/certificate-authority-service/docs/sorting-filtering-certificates#
sorting_support).
@param [Fixnum] page_size
Optional. Limit on the number of Certificates to include in the response.
Further Certificates can subsequently be obtained by including the
ListCertificatesResponse.next_page_token in a subsequent request. If
unspecified, the server will pick an appropriate default.
@param [String] page_token
Optional. Pagination token, returned earlier via ListCertificatesResponse.
next_page_token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ListCertificatesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ListCertificatesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_certificate_authority_certificates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/certificates', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ListCertificatesResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ListCertificatesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `“/v1/`name=users/*`/operations”` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. @param [String] name
The name of the operation's parent resource.
@param [String] filter
The standard list filter.
@param [Fixnum] page_size
The standard list page size.
@param [String] page_token
The standard list page token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ListOperationsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ListOperationsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
list_project_location_reusable_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Lists ReusableConfigs. @param [String] parent
Required. The resource name of the location associated with the
ReusableConfigs, in the format `projects/*/locations/*`.
@param [String] filter
Optional. Only include resources that match the filter in the response.
@param [String] order_by
Optional. Specify how the results should be sorted.
@param [Fixnum] page_size
Optional. Limit on the number of ReusableConfigs to include in the response.
Further ReusableConfigs can subsequently be obtained by including the
ListReusableConfigsResponse.next_page_token in a subsequent request. If
unspecified, the server will pick an appropriate default.
@param [String] page_token
Optional. Pagination token, returned earlier via ListReusableConfigsResponse.
next_page_token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ListReusableConfigsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ListReusableConfigsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_reusable_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/reusableConfigs', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ListReusableConfigsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ListReusableConfigsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Lists information about the supported locations for this service. @param [String] name
The resource that owns the locations collection, if applicable.
@param [String] filter
A filter to narrow down results to a preferred subset. The filtering language
accepts strings like "displayName=tokyo", and is documented in more detail in [
AIP-160](https://google.aip.dev/160).
@param [Fixnum] page_size
The maximum number of results to return. If not set, the service selects a
default.
@param [String] page_token
A page token received from the `next_page_token` field in the response. Send
that page token to receive the subsequent page.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::ListLocationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::ListLocationsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}/locations', options)
command.response_representation = Google::Apis::PrivatecaV1beta1::ListLocationsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::ListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
patch_project_location_certificate_authority(name, certificate_authority_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Update a CertificateAuthority
. @param [String] name
Output only. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::CertificateAuthority] certificate_authority_object @param [String] request_id
Optional. An ID to identify requests. Specify a unique request ID so that if
you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request. For example, consider a situation where you
make an initial request and t he request times out. If you make the request
again with the same request ID, the server can check if original operation
with the same request ID was received, and if so, will ignore the second
request. This prevents clients from accidentally creating duplicate
commitments. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
@param [String] update_mask
Required. A list of fields to be updated in this request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_certificate_authority(name, certificate_authority_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::CertificateAuthority::Representation
command.request_object = certificate_authority_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
patch_project_location_certificate_authority_certificate(name, certificate_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Update a Certificate
. Currently, the only field you can update is the labels field. @param [String] name
Output only. The resource path for this Certificate in the format `projects/*/
locations/*/certificateAuthorities/*/certificates/*`.
@param [Google::Apis::PrivatecaV1beta1::Certificate] certificate_object @param [String] request_id
Optional. An ID to identify requests. Specify a unique request ID so that if
you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request. For example, consider a situation where you
make an initial request and t he request times out. If you make the request
again with the same request ID, the server can check if original operation
with the same request ID was received, and if so, will ignore the second
request. This prevents clients from accidentally creating duplicate
commitments. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
@param [String] update_mask
Required. A list of fields to be updated in this request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Certificate] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Certificate]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_certificate_authority_certificate(name, certificate_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::Certificate::Representation
command.request_object = certificate_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Certificate::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Certificate
command.params['name'] = name unless name.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
patch_project_location_certificate_authority_certificate_revocation_list(name, certificate_revocation_list_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Update a CertificateRevocationList
. @param [String] name
Output only. The resource path for this CertificateRevocationList in the
format `projects/*/locations/*/certificateAuthorities/*/
certificateRevocationLists/*`.
@param [Google::Apis::PrivatecaV1beta1::CertificateRevocationList] certificate_revocation_list_object @param [String] request_id
Optional. An ID to identify requests. Specify a unique request ID so that if
you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request. For example, consider a situation where you
make an initial request and t he request times out. If you make the request
again with the same request ID, the server can check if original operation
with the same request ID was received, and if so, will ignore the second
request. This prevents clients from accidentally creating duplicate
commitments. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
@param [String] update_mask
Required. A list of fields to be updated in this request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_certificate_authority_certificate_revocation_list(name, certificate_revocation_list_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::CertificateRevocationList::Representation
command.request_object = certificate_revocation_list_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
restore_certificate_authority(name, restore_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Restore a CertificateAuthority
that is scheduled for deletion. @param [String] name
Required. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::RestoreCertificateAuthorityRequest] restore_certificate_authority_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def restore_certificate_authority(name, restore_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:restore', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::RestoreCertificateAuthorityRequest::Representation
command.request_object = restore_certificate_authority_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
revoke_certificate(name, revoke_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Revoke a Certificate
. @param [String] name
Required. The resource name for this Certificate in the format `projects/*/
locations/*/certificateAuthorities/*/certificates/*`.
@param [Google::Apis::PrivatecaV1beta1::RevokeCertificateRequest] revoke_certificate_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Certificate] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Certificate]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def revoke_certificate(name, revoke_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:revoke', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::RevokeCertificateRequest::Representation
command.request_object = revoke_certificate_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Certificate::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Certificate
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
schedule_delete_certificate_authority(name, schedule_delete_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Schedule a CertificateAuthority
for deletion. @param [String] name
Required. The resource name for this CertificateAuthority in the format `
projects/*/locations/*/certificateAuthorities/*`.
@param [Google::Apis::PrivatecaV1beta1::ScheduleDeleteCertificateAuthorityRequest] schedule_delete_certificate_authority_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def schedule_delete_certificate_authority(name, schedule_delete_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:scheduleDelete', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::ScheduleDeleteCertificateAuthorityRequest::Representation
command.request_object = schedule_delete_certificate_authority_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Operation::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
set_certificate_authority_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.
@param [Google::Apis::PrivatecaV1beta1::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def set_certificate_authority_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Policy::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
set_certificate_revocation_list_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.
@param [Google::Apis::PrivatecaV1beta1::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def set_certificate_revocation_list_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Policy::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
set_reusable_config_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.
@param [Google::Apis::PrivatecaV1beta1::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def set_reusable_config_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::Policy::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
test_certificate_authority_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a ` NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the
operation documentation for the appropriate value for this field.
@param [Google::Apis::PrivatecaV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def test_certificate_authority_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
test_certificate_revocation_list_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a ` NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the
operation documentation for the appropriate value for this field.
@param [Google::Apis::PrivatecaV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def test_certificate_revocation_list_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
test_reusable_config_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
click to toggle source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a ` NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the
operation documentation for the appropriate value for this field.
@param [Google::Apis::PrivatecaV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
def test_reusable_config_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::PrivatecaV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::PrivatecaV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end