Class CreateRolloutRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.deploy.v1.CreateRolloutRequest
All Implemented Interfaces:
CreateRolloutRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class CreateRolloutRequest extends com.google.protobuf.GeneratedMessage implements CreateRolloutRequestOrBuilder
 CreateRolloutRequest is the request object used by `CreateRollout`.
 
Protobuf type google.cloud.deploy.v1.CreateRolloutRequest
See Also:
  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:
    • ROLLOUT_ID_FIELD_NUMBER

      public static final int ROLLOUT_ID_FIELD_NUMBER
      See Also:
    • ROLLOUT_FIELD_NUMBER

      public static final int ROLLOUT_FIELD_NUMBER
      See Also:
    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_FIELD_NUMBER
      See Also:
    • VALIDATE_ONLY_FIELD_NUMBER

      public static final int VALIDATE_ONLY_FIELD_NUMBER
      See Also:
    • OVERRIDE_DEPLOY_POLICY_FIELD_NUMBER

      public static final int OVERRIDE_DEPLOY_POLICY_FIELD_NUMBER
      See Also:
    • STARTING_PHASE_ID_FIELD_NUMBER

      public static final int STARTING_PHASE_ID_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getParent

      public String getParent()
       Required. The parent collection in which the `Rollout` must be created.
       The format is
       `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface CreateRolloutRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The parent collection in which the `Rollout` must be created.
       The format is
       `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface CreateRolloutRequestOrBuilder
      Returns:
      The bytes for parent.
    • getRolloutId

      public String getRolloutId()
       Required. ID of the `Rollout`.
       
      string rollout_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRolloutId in interface CreateRolloutRequestOrBuilder
      Returns:
      The rolloutId.
    • getRolloutIdBytes

      public com.google.protobuf.ByteString getRolloutIdBytes()
       Required. ID of the `Rollout`.
       
      string rollout_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRolloutIdBytes in interface CreateRolloutRequestOrBuilder
      Returns:
      The bytes for rolloutId.
    • hasRollout

      public boolean hasRollout()
       Required. The `Rollout` to create.
       
      .google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasRollout in interface CreateRolloutRequestOrBuilder
      Returns:
      Whether the rollout field is set.
    • getRollout

      public Rollout getRollout()
       Required. The `Rollout` to create.
       
      .google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRollout in interface CreateRolloutRequestOrBuilder
      Returns:
      The rollout.
    • getRolloutOrBuilder

      public RolloutOrBuilder getRolloutOrBuilder()
       Required. The `Rollout` to create.
       
      .google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRolloutOrBuilder in interface CreateRolloutRequestOrBuilder
    • 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];
      Specified by:
      getRequestId in interface CreateRolloutRequestOrBuilder
      Returns:
      The requestId.
    • getRequestIdBytes

      public com.google.protobuf.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];
      Specified by:
      getRequestIdBytes in interface CreateRolloutRequestOrBuilder
      Returns:
      The bytes for requestId.
    • 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];
      Specified by:
      getValidateOnly in interface CreateRolloutRequestOrBuilder
      Returns:
      The validateOnly.
    • getOverrideDeployPolicyList

      public com.google.protobuf.ProtocolStringList getOverrideDeployPolicyList()
       Optional. Deploy policies to override. Format is
       `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
       
      repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getOverrideDeployPolicyList in interface CreateRolloutRequestOrBuilder
      Returns:
      A list containing the overrideDeployPolicy.
    • getOverrideDeployPolicyCount

      public int getOverrideDeployPolicyCount()
       Optional. Deploy policies to override. Format is
       `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
       
      repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getOverrideDeployPolicyCount in interface CreateRolloutRequestOrBuilder
      Returns:
      The count of overrideDeployPolicy.
    • getOverrideDeployPolicy

      public String getOverrideDeployPolicy(int index)
       Optional. Deploy policies to override. Format is
       `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
       
      repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getOverrideDeployPolicy in interface CreateRolloutRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The overrideDeployPolicy at the given index.
    • getOverrideDeployPolicyBytes

      public com.google.protobuf.ByteString getOverrideDeployPolicyBytes(int index)
       Optional. Deploy policies to override. Format is
       `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
       
      repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getOverrideDeployPolicyBytes in interface CreateRolloutRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the overrideDeployPolicy at the given index.
    • 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];
      Specified by:
      getStartingPhaseId in interface CreateRolloutRequestOrBuilder
      Returns:
      The startingPhaseId.
    • getStartingPhaseIdBytes

      public com.google.protobuf.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];
      Specified by:
      getStartingPhaseIdBytes in interface CreateRolloutRequestOrBuilder
      Returns:
      The bytes for startingPhaseId.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static CreateRolloutRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CreateRolloutRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CreateRolloutRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CreateRolloutRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CreateRolloutRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CreateRolloutRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CreateRolloutRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CreateRolloutRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CreateRolloutRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CreateRolloutRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CreateRolloutRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CreateRolloutRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public CreateRolloutRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static CreateRolloutRequest.Builder newBuilder()
    • newBuilder

      public static CreateRolloutRequest.Builder newBuilder(CreateRolloutRequest prototype)
    • toBuilder

      public CreateRolloutRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected CreateRolloutRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static CreateRolloutRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<CreateRolloutRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<CreateRolloutRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public CreateRolloutRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder