Class CreateRolloutRequest (1.44.0)

public final class CreateRolloutRequest extends GeneratedMessageV3 implements CreateRolloutRequestOrBuilder

CreateRolloutRequest is the request object used by CreateRollout.

Protobuf type google.cloud.deploy.v1.CreateRolloutRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_FIELD_NUMBER

public static final int ROLLOUT_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_ID_FIELD_NUMBER

public static final int ROLLOUT_ID_FIELD_NUMBER
Field Value
Type Description
int

STARTING_PHASE_ID_FIELD_NUMBER

public static final int STARTING_PHASE_ID_FIELD_NUMBER
Field Value
Type Description
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateRolloutRequest getDefaultInstance()
Returns
Type Description
CreateRolloutRequest

getDescriptor()

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

newBuilder()

public static CreateRolloutRequest.Builder newBuilder()
Returns
Type Description
CreateRolloutRequest.Builder

newBuilder(CreateRolloutRequest prototype)

public static CreateRolloutRequest.Builder newBuilder(CreateRolloutRequest prototype)
Parameter
Name Description
prototype CreateRolloutRequest
Returns
Type Description
CreateRolloutRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateRolloutRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRolloutRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateRolloutRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateRolloutRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateRolloutRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateRolloutRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateRolloutRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRolloutRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateRolloutRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRolloutRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateRolloutRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateRolloutRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRolloutRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateRolloutRequest> parser()
Returns
Type Description
Parser<CreateRolloutRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateRolloutRequest getDefaultInstanceForType()
Returns
Type Description
CreateRolloutRequest

getParent()

public String getParent()

Required. The parent collection in which the Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent collection in which the Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateRolloutRequest> getParserForType()
Returns
Type Description
Parser<CreateRolloutRequest>
Overrides

getRequestId()

public String getRequestId()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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 = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestId.

getRollout()

public Rollout getRollout()

Required. The Rollout to create.

.google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Rollout

The rollout.

getRolloutId()

public String getRolloutId()

Required. ID of the Rollout.

string rollout_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The rolloutId.

getRolloutIdBytes()

public ByteString getRolloutIdBytes()

Required. ID of the Rollout.

string rollout_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for rolloutId.

getRolloutOrBuilder()

public RolloutOrBuilder getRolloutOrBuilder()

Required. The Rollout to create.

.google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RolloutOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartingPhaseId()

public String getStartingPhaseId()

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

string starting_phase_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The startingPhaseId.

getStartingPhaseIdBytes()

public ByteString getStartingPhaseIdBytes()

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

string starting_phase_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for startingPhaseId.

getValidateOnly()

public boolean getValidateOnly()

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasRollout()

public boolean hasRollout()

Required. The Rollout to create.

.google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the rollout field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateRolloutRequest.Builder newBuilderForType()
Returns
Type Description
CreateRolloutRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateRolloutRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateRolloutRequest.Builder toBuilder()
Returns
Type Description
CreateRolloutRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException