com.hp.octane.integrations.dto.general.CIServerInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integrations-dto Show documentation
The newest version!
/**
 * Copyright 2017-2023 Open Text
 *
 * The only warranties for products and services of Open Text and
 * its affiliates and licensors (“Open Text”) are as may be set forth
 * in the express warranty statements accompanying such products and services.
 * Nothing herein should be construed as constituting an additional warranty.
 * Open Text shall not be liable for technical or editorial errors or
 * omissions contained herein. The information contained herein is subject
 * to change without notice.
 *
 * Except as specifically indicated otherwise, this document contains
 * confidential information and a valid license is required for possession,
 * use or copying. If this work is provided to the U.S. Government,
 * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
 * Computer Software Documentation, and Technical Data for Commercial Items are
 * licensed to the U.S. Government under vendor's standard commercial license.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hp.octane.integrations.dto.general;

import com.hp.octane.integrations.dto.DTOBase;

/**
 * CI Server info DTO
 */

public interface CIServerInfo extends DTOBase {

	/***
	 * Get type of CI server (jenkins,bamboo,goCd...)
	 * @return type of CI server
	 */
	String getType();

	/***
	 * 	 Set CI server's type
	 * 	 The type is an unbound string
	 * @param type CI server's type
	 * @return instance of current CIServerInfo
	 */
	CIServerInfo setType(String type);

	/***
	 * Get version of the CI server
	 * @return version of the CI server
	 */
	String getVersion();

	/***
	 * Set CI server's version
	 * @param version CI server's version
	 * @return instance of current CIServerInfo
	 */
	CIServerInfo setVersion(String version);

	/***
	 * Get self location URL to CI server
	 * @return self location URL to CI server
	 */
	String getUrl();

	/***
	 * Set CI server's self location URL
	 * @param url CI server's self location URL
	 * @return instance of current CIServerInfo
	 */
	CIServerInfo setUrl(String url);

	/***
	 * Get unique id of the CI server instance UUID
	 * @return unique id of the CI server
	 */
	String getInstanceId();

	/***
	 * Set unique id of the CI server instance UUID
	 * @param instanceId  unique id
	 * @return instance of current CIServerInfo
	 */
	CIServerInfo setInstanceId(String instanceId);

	/***
	 * Set CI server's instance creation time
	 * @return instance creation time
	 */
	Long getInstanceIdFrom();

	/***
	 * Set CI server's instance creation time
	 * @param instanceIdFrom CI server's instance creation time
	 * @return instance of current CIServerInfo
	 */
	CIServerInfo setInstanceIdFrom(Long instanceIdFrom);

	/***
	 * Get CI server's current time
	 * @return current time
	 */
	Long getSendingTime();

	/***
	 * Set CI server's current time
	 * @param sendingTime sendingTime
	 * @return instance of current CIServerInfo
	 */
	CIServerInfo setSendingTime(Long sendingTime);
}