com.azure.resourcemanager.appcontainers.models.Job Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-appcontainers Show documentation
Show all versions of azure-resourcemanager-appcontainers Show documentation
This package contains Microsoft Azure SDK for ContainerAppsApi Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Package tag package-2024-03.
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.appcontainers.models;
import com.azure.core.http.rest.Response;
import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.appcontainers.fluent.models.JobInner;
import java.util.List;
import java.util.Map;
/**
* An immutable client-side representation of Job.
*/
public interface Job {
/**
* 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 extendedLocation property: The complex type of the extended location.
*
* @return the extendedLocation value.
*/
ExtendedLocation extendedLocation();
/**
* Gets the identity property: Managed identities needed by a container app job to interact with other Azure
* services to not maintain any secrets or credentials in code.
*
* @return the identity value.
*/
ManagedServiceIdentity identity();
/**
* Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
* @return the systemData value.
*/
SystemData systemData();
/**
* Gets the provisioningState property: Provisioning state of the Container Apps Job.
*
* @return the provisioningState value.
*/
JobProvisioningState provisioningState();
/**
* Gets the runningState property: Current running state of the job.
*
* @return the runningState value.
*/
JobRunningState runningState();
/**
* Gets the environmentId property: Resource ID of environment.
*
* @return the environmentId value.
*/
String environmentId();
/**
* Gets the workloadProfileName property: Workload profile name to pin for container apps job execution.
*
* @return the workloadProfileName value.
*/
String workloadProfileName();
/**
* Gets the configuration property: Container Apps Job configuration properties.
*
* @return the configuration value.
*/
JobConfiguration configuration();
/**
* Gets the template property: Container Apps job definition.
*
* @return the template value.
*/
JobTemplate template();
/**
* Gets the outboundIpAddresses property: Outbound IP Addresses of a container apps job.
*
* @return the outboundIpAddresses value.
*/
List outboundIpAddresses();
/**
* Gets the eventStreamEndpoint property: The endpoint of the eventstream of the container apps job.
*
* @return the eventStreamEndpoint value.
*/
String eventStreamEndpoint();
/**
* 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.appcontainers.fluent.models.JobInner object.
*
* @return the inner object.
*/
JobInner innerModel();
/**
* The entirety of the Job definition.
*/
interface Definition extends DefinitionStages.Blank, DefinitionStages.WithLocation,
DefinitionStages.WithResourceGroup, DefinitionStages.WithCreate {
}
/**
* The Job definition stages.
*/
interface DefinitionStages {
/**
* The first stage of the Job definition.
*/
interface Blank extends WithLocation {
}
/**
* The stage of the Job 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 Job 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 Job 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.WithExtendedLocation,
DefinitionStages.WithIdentity, DefinitionStages.WithEnvironmentId, DefinitionStages.WithWorkloadProfileName,
DefinitionStages.WithConfiguration, DefinitionStages.WithTemplate {
/**
* Executes the create request.
*
* @return the created resource.
*/
Job create();
/**
* Executes the create request.
*
* @param context The context to associate with this operation.
* @return the created resource.
*/
Job create(Context context);
}
/**
* The stage of the Job 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 Job definition allowing to specify extendedLocation.
*/
interface WithExtendedLocation {
/**
* Specifies the extendedLocation property: The complex type of the extended location..
*
* @param extendedLocation The complex type of the extended location.
* @return the next definition stage.
*/
WithCreate withExtendedLocation(ExtendedLocation extendedLocation);
}
/**
* The stage of the Job definition allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: Managed identities needed by a container app job to interact with other
* Azure services to not maintain any secrets or credentials in code..
*
* @param identity Managed identities needed by a container app job to interact with other Azure services to
* not maintain any secrets or credentials in code.
* @return the next definition stage.
*/
WithCreate withIdentity(ManagedServiceIdentity identity);
}
/**
* The stage of the Job definition allowing to specify environmentId.
*/
interface WithEnvironmentId {
/**
* Specifies the environmentId property: Resource ID of environment..
*
* @param environmentId Resource ID of environment.
* @return the next definition stage.
*/
WithCreate withEnvironmentId(String environmentId);
}
/**
* The stage of the Job definition allowing to specify workloadProfileName.
*/
interface WithWorkloadProfileName {
/**
* Specifies the workloadProfileName property: Workload profile name to pin for container apps job
* execution..
*
* @param workloadProfileName Workload profile name to pin for container apps job execution.
* @return the next definition stage.
*/
WithCreate withWorkloadProfileName(String workloadProfileName);
}
/**
* The stage of the Job definition allowing to specify configuration.
*/
interface WithConfiguration {
/**
* Specifies the configuration property: Container Apps Job configuration properties..
*
* @param configuration Container Apps Job configuration properties.
* @return the next definition stage.
*/
WithCreate withConfiguration(JobConfiguration configuration);
}
/**
* The stage of the Job definition allowing to specify template.
*/
interface WithTemplate {
/**
* Specifies the template property: Container Apps job definition..
*
* @param template Container Apps job definition.
* @return the next definition stage.
*/
WithCreate withTemplate(JobTemplate template);
}
}
/**
* Begins update for the Job resource.
*
* @return the stage of resource update.
*/
Job.Update update();
/**
* The template for Job update.
*/
interface Update extends UpdateStages.WithTags, UpdateStages.WithExtendedLocation, UpdateStages.WithIdentity,
UpdateStages.WithProperties {
/**
* Executes the update request.
*
* @return the updated resource.
*/
Job apply();
/**
* Executes the update request.
*
* @param context The context to associate with this operation.
* @return the updated resource.
*/
Job apply(Context context);
}
/**
* The Job update stages.
*/
interface UpdateStages {
/**
* The stage of the Job 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 Job update allowing to specify extendedLocation.
*/
interface WithExtendedLocation {
/**
* Specifies the extendedLocation property: The complex type of the extended location..
*
* @param extendedLocation The complex type of the extended location.
* @return the next definition stage.
*/
Update withExtendedLocation(ExtendedLocation extendedLocation);
}
/**
* The stage of the Job update allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: Managed identities needed by a container app job to interact with other
* Azure services to not maintain any secrets or credentials in code..
*
* @param identity Managed identities needed by a container app job to interact with other Azure services to
* not maintain any secrets or credentials in code.
* @return the next definition stage.
*/
Update withIdentity(ManagedServiceIdentity identity);
}
/**
* The stage of the Job update allowing to specify properties.
*/
interface WithProperties {
/**
* Specifies the properties property: The properties property..
*
* @param properties The properties property.
* @return the next definition stage.
*/
Update withProperties(JobPatchPropertiesProperties properties);
}
}
/**
* Refreshes the resource to sync with Azure.
*
* @return the refreshed resource.
*/
Job refresh();
/**
* Refreshes the resource to sync with Azure.
*
* @param context The context to associate with this operation.
* @return the refreshed resource.
*/
Job refresh(Context context);
/**
* Start a Container Apps Job.
*
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App's Job execution name.
*/
JobExecutionBase start();
/**
* Start a Container Apps Job.
*
* @param template Properties used to start a job execution.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App's Job execution name.
*/
JobExecutionBase start(JobExecutionTemplate template, Context context);
/**
* Terminates execution of a running container apps job.
*
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App executions collection ARM resource.
*/
ContainerAppJobExecutions stopMultipleExecutions();
/**
* Terminates execution of a running container apps job.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App executions collection ARM resource.
*/
ContainerAppJobExecutions stopMultipleExecutions(Context context);
/**
* List secrets for a container apps job.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container Apps Job Secrets Collection ARM resource along with {@link Response}.
*/
Response listSecretsWithResponse(Context context);
/**
* List secrets for a container apps job.
*
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container Apps Job Secrets Collection ARM resource.
*/
JobSecretsCollection listSecrets();
/**
* Resumes a suspended job.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App Job.
*/
Job resume();
/**
* Resumes a suspended job.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App Job.
*/
Job resume(Context context);
/**
* Suspends a job.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App Job.
*/
Job suspend();
/**
* Suspends a job.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return container App Job.
*/
Job suspend(Context context);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy