Class PatchSubnetworkRequest (1.31.0)

public final class PatchSubnetworkRequest extends GeneratedMessageV3 implements PatchSubnetworkRequestOrBuilder

A request message for Subnetworks.Patch. See the method description for details.

Protobuf type google.cloud.compute.v1.PatchSubnetworkRequest

Static Fields

DRAIN_TIMEOUT_SECONDS_FIELD_NUMBER

public static final int DRAIN_TIMEOUT_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_RESOURCE_FIELD_NUMBER

public static final int SUBNETWORK_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PatchSubnetworkRequest getDefaultInstance()
Returns
TypeDescription
PatchSubnetworkRequest

getDescriptor()

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

newBuilder()

public static PatchSubnetworkRequest.Builder newBuilder()
Returns
TypeDescription
PatchSubnetworkRequest.Builder

newBuilder(PatchSubnetworkRequest prototype)

public static PatchSubnetworkRequest.Builder newBuilder(PatchSubnetworkRequest prototype)
Parameter
NameDescription
prototypePatchSubnetworkRequest
Returns
TypeDescription
PatchSubnetworkRequest.Builder

parseDelimitedFrom(InputStream input)

public static PatchSubnetworkRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchSubnetworkRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PatchSubnetworkRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchSubnetworkRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchSubnetworkRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchSubnetworkRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchSubnetworkRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchSubnetworkRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PatchSubnetworkRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchSubnetworkRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PatchSubnetworkRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchSubnetworkRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchSubnetworkRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PatchSubnetworkRequest> parser()
Returns
TypeDescription
Parser<PatchSubnetworkRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PatchSubnetworkRequest getDefaultInstanceForType()
Returns
TypeDescription
PatchSubnetworkRequest

getDrainTimeoutSeconds()

public int getDrainTimeoutSeconds()

The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

optional int32 drain_timeout_seconds = 357707098;

Returns
TypeDescription
int

The drainTimeoutSeconds.

getParserForType()

public Parser<PatchSubnetworkRequest> getParserForType()
Returns
TypeDescription
Parser<PatchSubnetworkRequest>
Overrides

getProject()

public String getProject()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];

Returns
TypeDescription
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];

Returns
TypeDescription
ByteString

The bytes for project.

getRegion()

public String getRegion()

Name of the region scoping this request.

string region = 138946292 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "region"];

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

Name of the region scoping this request.

string region = 138946292 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "region"];

Returns
TypeDescription
ByteString

The bytes for region.

getRequestId()

public String getRequestId()

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. 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).

optional string request_id = 37109963;

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

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. 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).

optional string request_id = 37109963;

Returns
TypeDescription
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubnetwork()

public String getSubnetwork()

Name of the Subnetwork resource to patch.

string subnetwork = 307827694 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

Name of the Subnetwork resource to patch.

string subnetwork = 307827694 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for subnetwork.

getSubnetworkResource()

public Subnetwork getSubnetworkResource()

The body resource for this request

.google.cloud.compute.v1.Subnetwork subnetwork_resource = 42233151 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Subnetwork

The subnetworkResource.

getSubnetworkResourceOrBuilder()

public SubnetworkOrBuilder getSubnetworkResourceOrBuilder()

The body resource for this request

.google.cloud.compute.v1.Subnetwork subnetwork_resource = 42233151 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SubnetworkOrBuilder

hasDrainTimeoutSeconds()

public boolean hasDrainTimeoutSeconds()

The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

optional int32 drain_timeout_seconds = 357707098;

Returns
TypeDescription
boolean

Whether the drainTimeoutSeconds field is set.

hasRequestId()

public boolean hasRequestId()

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. 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).

optional string request_id = 37109963;

Returns
TypeDescription
boolean

Whether the requestId field is set.

hasSubnetworkResource()

public boolean hasSubnetworkResource()

The body resource for this request

.google.cloud.compute.v1.Subnetwork subnetwork_resource = 42233151 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the subnetworkResource field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PatchSubnetworkRequest.Builder newBuilderForType()
Returns
TypeDescription
PatchSubnetworkRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchSubnetworkRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PatchSubnetworkRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PatchSubnetworkRequest.Builder toBuilder()
Returns
TypeDescription
PatchSubnetworkRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException