Class CreateRolloutRequest

  • All Implemented Interfaces:
    CreateRolloutRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CreateRolloutRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CreateRolloutRequestOrBuilder
     CreateRolloutRequest is the request object used by `CreateRollout`.
     
    Protobuf type google.cloud.deploy.v1.CreateRolloutRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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) = { ... }
        Specified by:
        getParent in interface CreateRolloutRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.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) = { ... }
        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.
      • 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 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 = 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 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 = 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.
      • 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.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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
      • newBuilderForType

        public CreateRolloutRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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