Class UpdateKeyRequest.Builder (0.43.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateKeyRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateKeyRequest.Builder
Overrides

build()

public UpdateKeyRequest build()
Returns
Type Description
UpdateKeyRequest

buildPartial()

public UpdateKeyRequest buildPartial()
Returns
Type Description
UpdateKeyRequest

clear()

public UpdateKeyRequest.Builder clear()
Returns
Type Description
UpdateKeyRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateKeyRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
UpdateKeyRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateKeyRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
UpdateKeyRequest.Builder

clone()

public UpdateKeyRequest.Builder clone()
Returns
Type Description
UpdateKeyRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateKeyRequest getDefaultInstanceForType()
Returns
Type Description
UpdateKeyRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateKeyRequest other)

public UpdateKeyRequest.Builder mergeFrom(UpdateKeyRequest other)
Parameter
Name Description
other UpdateKeyRequest
Returns
Type Description
UpdateKeyRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateKeyRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateKeyRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateKeyRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value Key
Returns
Type Description
UpdateKeyRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateKeyRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value FieldMask
Returns
Type Description
UpdateKeyRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateKeyRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value Key
Returns
Type Description
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
Name Description
builderForValue Key.Builder
Returns
Type Description
UpdateKeyRequest.Builder

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

public UpdateKeyRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateKeyRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateKeyRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value FieldMask
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
UpdateKeyRequest.Builder