Class UpdateApiRequest.Builder (2.83.0)

public static final class UpdateApiRequest.Builder extends GeneratedMessage.Builder<UpdateApiRequest.Builder> implements UpdateApiRequestOrBuilder

Request message for ApiGatewayService.UpdateApi

Protobuf type google.cloud.apigateway.v1.UpdateApiRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public UpdateApiRequest build()
Returns
Type Description
UpdateApiRequest

buildPartial()

public UpdateApiRequest buildPartial()
Returns
Type Description
UpdateApiRequest

clear()

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

clearApi()

public UpdateApiRequest.Builder clearApi()

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateApiRequest.Builder

clearUpdateMask()

public UpdateApiRequest.Builder clearUpdateMask()

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Returns
Type Description
UpdateApiRequest.Builder

getApi()

public Api getApi()

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Api

The api.

getApiBuilder()

public Api.Builder getApiBuilder()

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Api.Builder

getApiOrBuilder()

public ApiOrBuilder getApiOrBuilder()

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ApiOrBuilder

getDefaultInstanceForType()

public UpdateApiRequest getDefaultInstanceForType()
Returns
Type Description
UpdateApiRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getUpdateMask()

public FieldMask getUpdateMask()

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Returns
Type Description
FieldMaskOrBuilder

hasApi()

public boolean hasApi()

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the api field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeApi(Api value)

public UpdateApiRequest.Builder mergeApi(Api value)

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Api
Returns
Type Description
UpdateApiRequest.Builder

mergeFrom(UpdateApiRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public UpdateApiRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateApiRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateApiRequest.Builder mergeUpdateMask(FieldMask value)

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateApiRequest.Builder

setApi(Api value)

public UpdateApiRequest.Builder setApi(Api value)

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Api
Returns
Type Description
UpdateApiRequest.Builder

setApi(Api.Builder builderForValue)

public UpdateApiRequest.Builder setApi(Api.Builder builderForValue)

Required. API resource.

.google.cloud.apigateway.v1.Api api = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Api.Builder
Returns
Type Description
UpdateApiRequest.Builder

setUpdateMask(FieldMask value)

public UpdateApiRequest.Builder setUpdateMask(FieldMask value)

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateApiRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateApiRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateApiRequest.Builder