Class UpdateKeyRequest.Builder (0.27.0)

public static final class UpdateKeyRequest.Builder extends GeneratedMessageV3.Builder<UpdateKeyRequest.Builder> implements UpdateKeyRequestOrBuilder

Request message for UpdateKey method.

Protobuf type google.api.apikeys.v2.UpdateKeyRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateKeyRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

build()

public UpdateKeyRequest build()
Returns
TypeDescription
UpdateKeyRequest

buildPartial()

public UpdateKeyRequest buildPartial()
Returns
TypeDescription
UpdateKeyRequest

clear()

public UpdateKeyRequest.Builder clear()
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateKeyRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

clearKey()

public UpdateKeyRequest.Builder clearKey()

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
UpdateKeyRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateKeyRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

clearUpdateMask()

public UpdateKeyRequest.Builder clearUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
UpdateKeyRequest.Builder

clone()

public UpdateKeyRequest.Builder clone()
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateKeyRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateKeyRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getKey()

public Key getKey()

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Key

The key.

getKeyBuilder()

public Key.Builder getKeyBuilder()

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Key.Builder

getKeyOrBuilder()

public KeyOrBuilder getKeyOrBuilder()

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
KeyOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
FieldMaskOrBuilder

hasKey()

public boolean hasKey()

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the key field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UpdateKeyRequest other)

public UpdateKeyRequest.Builder mergeFrom(UpdateKeyRequest other)
Parameter
NameDescription
otherUpdateKeyRequest
Returns
TypeDescription
UpdateKeyRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateKeyRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateKeyRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

mergeKey(Key value)

public UpdateKeyRequest.Builder mergeKey(Key value)

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueKey
Returns
TypeDescription
UpdateKeyRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateKeyRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateKeyRequest.Builder mergeUpdateMask(FieldMask value)

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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateKeyRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateKeyRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

setKey(Key value)

public UpdateKeyRequest.Builder setKey(Key value)

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueKey
Returns
TypeDescription
UpdateKeyRequest.Builder

setKey(Key.Builder builderForValue)

public UpdateKeyRequest.Builder setKey(Key.Builder builderForValue)

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.

.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueKey.Builder
Returns
TypeDescription
UpdateKeyRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateKeyRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateKeyRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateKeyRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateKeyRequest.Builder setUpdateMask(FieldMask value)

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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateKeyRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateKeyRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateKeyRequest.Builder