Class UpdateServerRequest.Builder (0.4.0)

public static final class UpdateServerRequest.Builder extends GeneratedMessage.Builder<UpdateServerRequest.Builder> implements UpdateServerRequestOrBuilder

Message for updating a Server

Protobuf type google.cloud.ftp.v1.UpdateServerRequest

Static Methods

getDescriptor()

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

Methods

build()

public UpdateServerRequest build()
Returns
Type Description
UpdateServerRequest

buildPartial()

public UpdateServerRequest buildPartial()
Returns
Type Description
UpdateServerRequest

clear()

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

clearRequestId()

public UpdateServerRequest.Builder clearRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
UpdateServerRequest.Builder

This builder for chaining.

clearServer()

public UpdateServerRequest.Builder clearServer()

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateServerRequest.Builder

clearUpdateMask()

public UpdateServerRequest.Builder clearUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateServerRequest.Builder

getDefaultInstanceForType()

public UpdateServerRequest getDefaultInstanceForType()
Returns
Type Description
UpdateServerRequest

getDescriptorForType()

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

getRequestId()

public String getRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

getServer()

public Server getServer()

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Server

The server.

getServerBuilder()

public Server.Builder getServerBuilder()

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Server.Builder

getServerOrBuilder()

public ServerOrBuilder getServerOrBuilder()

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ServerOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasServer()

public boolean hasServer()

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the server field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

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

mergeFrom(UpdateServerRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeServer(Server value)

public UpdateServerRequest.Builder mergeServer(Server value)

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Server
Returns
Type Description
UpdateServerRequest.Builder

mergeUpdateMask(FieldMask value)

public UpdateServerRequest.Builder mergeUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateServerRequest.Builder

setRequestId(String value)

public UpdateServerRequest.Builder setRequestId(String value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
UpdateServerRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public UpdateServerRequest.Builder setRequestIdBytes(ByteString value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
UpdateServerRequest.Builder

This builder for chaining.

setServer(Server value)

public UpdateServerRequest.Builder setServer(Server value)

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Server
Returns
Type Description
UpdateServerRequest.Builder

setServer(Server.Builder builderForValue)

public UpdateServerRequest.Builder setServer(Server.Builder builderForValue)

Required. The resource being updated

.google.cloud.ftp.v1.Server server = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Server.Builder
Returns
Type Description
UpdateServerRequest.Builder

setUpdateMask(FieldMask value)

public UpdateServerRequest.Builder setUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateServerRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateServerRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateServerRequest.Builder