com.azure.resourcemanager.applicationinsights.models.Workbook Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-applicationinsights Show documentation
Show all versions of azure-resourcemanager-applicationinsights Show documentation
This package contains Microsoft Azure SDK for ApplicationInsights Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Composite Swagger for Application Insights Management Client. Package tag package-2022-04-01.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.applicationinsights.models;
import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.applicationinsights.fluent.models.WorkbookInner;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;
/** An immutable client-side representation of Workbook. */
public interface Workbook {
/**
* Gets the id property: Fully qualified resource Id for the resource.
*
* @return the id value.
*/
String id();
/**
* Gets the name property: The name of the resource.
*
* @return the name value.
*/
String name();
/**
* Gets the type property: The type of the resource.
*
* @return the type value.
*/
String type();
/**
* Gets the location property: The geo-location where the resource lives.
*
* @return the location value.
*/
String location();
/**
* Gets the tags property: Resource tags.
*
* @return the tags value.
*/
Map tags();
/**
* Gets the identity property: Identity used for BYOS.
*
* @return the identity value.
*/
WorkbookResourceIdentity identity();
/**
* Gets the kind property: The kind of workbook. Only valid value is shared.
*
* @return the kind value.
*/
WorkbookSharedTypeKind kind();
/**
* Gets the etag property: Resource etag.
*
* @return the etag value.
*/
String etag();
/**
* Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
*
* @return the systemData value.
*/
SystemData systemData();
/**
* Gets the displayName property: The user-defined name (display name) of the workbook.
*
* @return the displayName value.
*/
String displayName();
/**
* Gets the serializedData property: Configuration of this particular workbook. Configuration data is a string
* containing valid JSON.
*
* @return the serializedData value.
*/
String serializedData();
/**
* Gets the version property: Workbook schema version format, like 'Notebook/1.0', which should match the workbook
* in serializedData.
*
* @return the version value.
*/
String version();
/**
* Gets the timeModified property: Date and time in UTC of the last modification that was made to this workbook
* definition.
*
* @return the timeModified value.
*/
OffsetDateTime timeModified();
/**
* Gets the category property: Workbook category, as defined by the user at creation time.
*
* @return the category value.
*/
String category();
/**
* Gets the tagsPropertiesTags property: Being deprecated, please use the other tags field.
*
* @return the tagsPropertiesTags value.
*/
List tagsPropertiesTags();
/**
* Gets the userId property: Unique user id of the specific user that owns this workbook.
*
* @return the userId value.
*/
String userId();
/**
* Gets the sourceId property: ResourceId for a source resource.
*
* @return the sourceId value.
*/
String sourceId();
/**
* Gets the storageUri property: The resourceId to the storage account when bring your own storage is used.
*
* @return the storageUri value.
*/
String storageUri();
/**
* Gets the description property: The description of the workbook.
*
* @return the description value.
*/
String description();
/**
* Gets the revision property: The unique revision id for this workbook definition.
*
* @return the revision value.
*/
String revision();
/**
* Gets the region of the resource.
*
* @return the region of the resource.
*/
Region region();
/**
* Gets the name of the resource region.
*
* @return the name of the resource region.
*/
String regionName();
/**
* Gets the name of the resource group.
*
* @return the name of the resource group.
*/
String resourceGroupName();
/**
* Gets the inner com.azure.resourcemanager.applicationinsights.fluent.models.WorkbookInner object.
*
* @return the inner object.
*/
WorkbookInner innerModel();
/** The entirety of the Workbook definition. */
interface Definition
extends DefinitionStages.Blank,
DefinitionStages.WithLocation,
DefinitionStages.WithResourceGroup,
DefinitionStages.WithCreate {
}
/** The Workbook definition stages. */
interface DefinitionStages {
/** The first stage of the Workbook definition. */
interface Blank extends WithLocation {
}
/** The stage of the Workbook definition allowing to specify location. */
interface WithLocation {
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(Region location);
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(String location);
}
/** The stage of the Workbook definition allowing to specify parent resource. */
interface WithResourceGroup {
/**
* Specifies resourceGroupName.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @return the next definition stage.
*/
WithCreate withExistingResourceGroup(String resourceGroupName);
}
/**
* The stage of the Workbook definition which contains all the minimum required properties for the resource to
* be created, but also allows for any other optional properties to be specified.
*/
interface WithCreate
extends DefinitionStages.WithTags,
DefinitionStages.WithIdentity,
DefinitionStages.WithKind,
DefinitionStages.WithEtag,
DefinitionStages.WithDisplayName,
DefinitionStages.WithSerializedData,
DefinitionStages.WithVersion,
DefinitionStages.WithCategory,
DefinitionStages.WithTagsPropertiesTags,
DefinitionStages.WithSourceId,
DefinitionStages.WithStorageUri,
DefinitionStages.WithDescription,
DefinitionStages.WithSourceIdParameter {
/**
* Executes the create request.
*
* @return the created resource.
*/
Workbook create();
/**
* Executes the create request.
*
* @param context The context to associate with this operation.
* @return the created resource.
*/
Workbook create(Context context);
}
/** The stage of the Workbook definition allowing to specify tags. */
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
WithCreate withTags(Map tags);
}
/** The stage of the Workbook definition allowing to specify identity. */
interface WithIdentity {
/**
* Specifies the identity property: Identity used for BYOS.
*
* @param identity Identity used for BYOS.
* @return the next definition stage.
*/
WithCreate withIdentity(WorkbookResourceIdentity identity);
}
/** The stage of the Workbook definition allowing to specify kind. */
interface WithKind {
/**
* Specifies the kind property: The kind of workbook. Only valid value is shared..
*
* @param kind The kind of workbook. Only valid value is shared.
* @return the next definition stage.
*/
WithCreate withKind(WorkbookSharedTypeKind kind);
}
/** The stage of the Workbook definition allowing to specify etag. */
interface WithEtag {
/**
* Specifies the etag property: Resource etag.
*
* @param etag Resource etag.
* @return the next definition stage.
*/
WithCreate withEtag(String etag);
}
/** The stage of the Workbook definition allowing to specify displayName. */
interface WithDisplayName {
/**
* Specifies the displayName property: The user-defined name (display name) of the workbook..
*
* @param displayName The user-defined name (display name) of the workbook.
* @return the next definition stage.
*/
WithCreate withDisplayName(String displayName);
}
/** The stage of the Workbook definition allowing to specify serializedData. */
interface WithSerializedData {
/**
* Specifies the serializedData property: Configuration of this particular workbook. Configuration data is a
* string containing valid JSON.
*
* @param serializedData Configuration of this particular workbook. Configuration data is a string
* containing valid JSON.
* @return the next definition stage.
*/
WithCreate withSerializedData(String serializedData);
}
/** The stage of the Workbook definition allowing to specify version. */
interface WithVersion {
/**
* Specifies the version property: Workbook schema version format, like 'Notebook/1.0', which should match
* the workbook in serializedData.
*
* @param version Workbook schema version format, like 'Notebook/1.0', which should match the workbook in
* serializedData.
* @return the next definition stage.
*/
WithCreate withVersion(String version);
}
/** The stage of the Workbook definition allowing to specify category. */
interface WithCategory {
/**
* Specifies the category property: Workbook category, as defined by the user at creation time..
*
* @param category Workbook category, as defined by the user at creation time.
* @return the next definition stage.
*/
WithCreate withCategory(String category);
}
/** The stage of the Workbook definition allowing to specify tagsPropertiesTags. */
interface WithTagsPropertiesTags {
/**
* Specifies the tagsPropertiesTags property: Being deprecated, please use the other tags field.
*
* @param tagsPropertiesTags Being deprecated, please use the other tags field.
* @return the next definition stage.
*/
WithCreate withTagsPropertiesTags(List tagsPropertiesTags);
}
/** The stage of the Workbook definition allowing to specify sourceId. */
interface WithSourceId {
/**
* Specifies the sourceId property: ResourceId for a source resource..
*
* @param sourceId ResourceId for a source resource.
* @return the next definition stage.
*/
WithCreate withSourceId(String sourceId);
}
/** The stage of the Workbook definition allowing to specify storageUri. */
interface WithStorageUri {
/**
* Specifies the storageUri property: The resourceId to the storage account when bring your own storage is
* used.
*
* @param storageUri The resourceId to the storage account when bring your own storage is used.
* @return the next definition stage.
*/
WithCreate withStorageUri(String storageUri);
}
/** The stage of the Workbook definition allowing to specify description. */
interface WithDescription {
/**
* Specifies the description property: The description of the workbook..
*
* @param description The description of the workbook.
* @return the next definition stage.
*/
WithCreate withDescription(String description);
}
/** The stage of the Workbook definition allowing to specify sourceId. */
interface WithSourceIdParameter {
/**
* Specifies the sourceId property: Azure Resource Id that will fetch all linked workbooks..
*
* @param sourceId Azure Resource Id that will fetch all linked workbooks.
* @return the next definition stage.
*/
WithCreate withSourceIdParameter(String sourceId);
}
}
/**
* Begins update for the Workbook resource.
*
* @return the stage of resource update.
*/
Workbook.Update update();
/** The template for Workbook update. */
interface Update
extends UpdateStages.WithTags,
UpdateStages.WithKind,
UpdateStages.WithDisplayName,
UpdateStages.WithSerializedData,
UpdateStages.WithCategory,
UpdateStages.WithTagsPropertiesTags,
UpdateStages.WithDescription,
UpdateStages.WithRevision,
UpdateStages.WithSourceId {
/**
* Executes the update request.
*
* @return the updated resource.
*/
Workbook apply();
/**
* Executes the update request.
*
* @param context The context to associate with this operation.
* @return the updated resource.
*/
Workbook apply(Context context);
}
/** The Workbook update stages. */
interface UpdateStages {
/** The stage of the Workbook update allowing to specify tags. */
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
Update withTags(Map tags);
}
/** The stage of the Workbook update allowing to specify kind. */
interface WithKind {
/**
* Specifies the kind property: The kind of workbook. Only valid value is shared..
*
* @param kind The kind of workbook. Only valid value is shared.
* @return the next definition stage.
*/
Update withKind(WorkbookUpdateSharedTypeKind kind);
}
/** The stage of the Workbook update allowing to specify displayName. */
interface WithDisplayName {
/**
* Specifies the displayName property: The user-defined name (display name) of the workbook..
*
* @param displayName The user-defined name (display name) of the workbook.
* @return the next definition stage.
*/
Update withDisplayName(String displayName);
}
/** The stage of the Workbook update allowing to specify serializedData. */
interface WithSerializedData {
/**
* Specifies the serializedData property: Configuration of this particular workbook. Configuration data is a
* string containing valid JSON.
*
* @param serializedData Configuration of this particular workbook. Configuration data is a string
* containing valid JSON.
* @return the next definition stage.
*/
Update withSerializedData(String serializedData);
}
/** The stage of the Workbook update allowing to specify category. */
interface WithCategory {
/**
* Specifies the category property: Workbook category, as defined by the user at creation time..
*
* @param category Workbook category, as defined by the user at creation time.
* @return the next definition stage.
*/
Update withCategory(String category);
}
/** The stage of the Workbook update allowing to specify tagsPropertiesTags. */
interface WithTagsPropertiesTags {
/**
* Specifies the tagsPropertiesTags property: A list of 0 or more tags that are associated with this
* workbook definition.
*
* @param tagsPropertiesTags A list of 0 or more tags that are associated with this workbook definition.
* @return the next definition stage.
*/
Update withTagsPropertiesTags(List tagsPropertiesTags);
}
/** The stage of the Workbook update allowing to specify description. */
interface WithDescription {
/**
* Specifies the description property: The description of the workbook..
*
* @param description The description of the workbook.
* @return the next definition stage.
*/
Update withDescription(String description);
}
/** The stage of the Workbook update allowing to specify revision. */
interface WithRevision {
/**
* Specifies the revision property: The unique revision id for this workbook definition.
*
* @param revision The unique revision id for this workbook definition.
* @return the next definition stage.
*/
Update withRevision(String revision);
}
/** The stage of the Workbook update allowing to specify sourceId. */
interface WithSourceId {
/**
* Specifies the sourceId property: Azure Resource Id that will fetch all linked workbooks..
*
* @param sourceId Azure Resource Id that will fetch all linked workbooks.
* @return the next definition stage.
*/
Update withSourceId(String sourceId);
}
}
/**
* Refreshes the resource to sync with Azure.
*
* @return the refreshed resource.
*/
Workbook refresh();
/**
* Refreshes the resource to sync with Azure.
*
* @param context The context to associate with this operation.
* @return the refreshed resource.
*/
Workbook refresh(Context context);
}