com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-security-keyvault-administration Show documentation

This module contains client library for Microsoft Azure KeyVault Administration.

There is a newer version: 4.6.0

Show newest version

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.security.keyvault.administration.models;

import com.azure.core.annotation.Immutable;

import java.time.OffsetDateTime;

/**
 * A class that contains the details of a long running operation.
 */
@Immutable
public class KeyVaultLongRunningOperation {
    private final String status;
    private final String statusDetails;
    private final KeyVaultAdministrationError error;
    private final String operationId;
    private final OffsetDateTime startTime;
    private final OffsetDateTime endTime;

    /**
     * Creates an object containing the details of a {@link KeyVaultLongRunningOperation}.
     *
     * @param status Status of the {@link KeyVaultLongRunningOperation}.
     * @param statusDetails The status details of the {@link KeyVaultLongRunningOperation}.
     * @param operationId Identifier for the full {@link KeyVaultLongRunningOperation}.
     * @param error Error encountered, if any, during the {@link KeyVaultLongRunningOperation}.
     * @param startTime The start time of the {@link KeyVaultLongRunningOperation}.
     * @param endTime The end time of the {@link KeyVaultLongRunningOperation}.
     */
    public KeyVaultLongRunningOperation(String status, String statusDetails, KeyVaultAdministrationError error,
                                        String operationId, OffsetDateTime startTime, OffsetDateTime endTime) {
        this.status = status;
        this.statusDetails = statusDetails;
        this.error = error;
        this.startTime = startTime;
        this.endTime = endTime;
        this.operationId = operationId;
    }

    /**
     * Get the status of the {@link KeyVaultLongRunningOperation}.
     *
     * @return The backup status.
     */
    public String getStatus() {
        return status;
    }

    /**
     * Get the status details of the {@link KeyVaultLongRunningOperation}.
     *
     * @return The backup status details.
     */
    public String getStatusDetails() {
        return statusDetails;
    }

    /**
     * Get the identifier for the {@link KeyVaultLongRunningOperation}.
     *
     * @return The operation ID.
     */
    public String getOperationId() {
        return operationId;
    }

    /**
     * Get the error encountered, if any, during the {@link KeyVaultLongRunningOperation}.
     *
     * @return The error.
     */
    public KeyVaultAdministrationError getError() {
        return error;
    }

    /**
     * Get the start time of the {@link KeyVaultLongRunningOperation}.
     *
     * @return The start time.
     */
    public OffsetDateTime getStartTime() {
        return startTime;
    }

    /**
     * Get the end time of the {@link KeyVaultLongRunningOperation}.
     *
     * @return The end time.
     */
    public OffsetDateTime getEndTime() {
        return endTime;
    }
}