API Keys V2 API - Class Google::Cloud::ApiKeys::V2::UpdateKeyRequest (v0.4.0)

Reference documentation and code samples for the API Keys V2 API class Google::Cloud::ApiKeys::V2::UpdateKeyRequest.

Request message for UpdateKey method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#key

def key() -> ::Google::Cloud::ApiKeys::V2::Key
Returns
  • (::Google::Cloud::ApiKeys::V2::Key) — Required. Set the name field to the resource name of the API key to be updated. You can update only the display_name, restrictions, and annotations fields.

#key=

def key=(value) -> ::Google::Cloud::ApiKeys::V2::Key
Parameter
  • value (::Google::Cloud::ApiKeys::V2::Key) — Required. Set the name field to the resource name of the API key to be updated. You can update only the display_name, restrictions, and annotations fields.
Returns
  • (::Google::Cloud::ApiKeys::V2::Key) — Required. Set the name field to the resource name of the API key to be updated. You can update only the display_name, restrictions, and annotations fields.

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: display_name, restrictions, and annotations. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: display_name, restrictions, and annotations. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields.
Returns
  • (::Google::Protobuf::FieldMask) — The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: display_name, restrictions, and annotations. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields.