def update_ssh_public_key(
self,
request: oslogin.UpdateSshPublicKeyRequest = None,
*,
name: str = None,
ssh_public_key: common.SshPublicKey = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> common.SshPublicKey:
r"""Updates an SSH public key and returns the profile
information. This method supports patch semantics.
Args:
request (google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest):
The request object. A request message for updating an
SSH public key.
name (str):
Required. The fingerprint of the public key to update.
Public keys are identified by their SHA-256 fingerprint.
The fingerprint of the public key is in format
``users/{user}/sshPublicKeys/{fingerprint}``.
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
ssh_public_key (google.cloud.oslogin.v1.common.SshPublicKey):
Required. The SSH public key and
expiration time.
This corresponds to the ``ssh_public_key`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Mask to control which fields get
updated. Updates all if not present.
This corresponds to the ``update_mask`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.oslogin.v1.common.SshPublicKey:
The SSH public key information
associated with a Google account.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name, ssh_public_key, update_mask])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a oslogin.UpdateSshPublicKeyRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, oslogin.UpdateSshPublicKeyRequest):
request = oslogin.UpdateSshPublicKeyRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if ssh_public_key is not None:
request.ssh_public_key = ssh_public_key
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_ssh_public_key]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
async def update_ssh_public_key(
self,
request: oslogin.UpdateSshPublicKeyRequest = None,
*,
name: str = None,
ssh_public_key: common.SshPublicKey = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> common.SshPublicKey:
r"""Updates an SSH public key and returns the profile
information. This method supports patch semantics.
Args:
request (:class:`google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest`):
The request object. A request message for updating an
SSH public key.
name (:class:`str`):
Required. The fingerprint of the public key to update.
Public keys are identified by their SHA-256 fingerprint.
The fingerprint of the public key is in format
``users/{user}/sshPublicKeys/{fingerprint}``.
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
ssh_public_key (:class:`google.cloud.oslogin.v1.common.SshPublicKey`):
Required. The SSH public key and
expiration time.
This corresponds to the ``ssh_public_key`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Mask to control which fields get
updated. Updates all if not present.
This corresponds to the ``update_mask`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.oslogin.v1.common.SshPublicKey:
The SSH public key information
associated with a Google account.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name, ssh_public_key, update_mask])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = oslogin.UpdateSshPublicKeyRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
if ssh_public_key is not None:
request.ssh_public_key = ssh_public_key
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.update_ssh_public_key,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.ServiceUnavailable,
),
deadline=10.0,
),
default_timeout=10.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response