All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.azure.resourcemanager.orbital.models.ContactProfile Maven / Gradle / Ivy

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.orbital.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.orbital.fluent.models.ContactProfileInner;
import java.util.List;
import java.util.Map;

/**
 * An immutable client-side representation of ContactProfile.
 */
public interface ContactProfile {
    /**
     * 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 systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     * 
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the provisioningState property: The current state of the resource's creation, deletion, or modification.
     * 
     * @return the provisioningState value.
     */
    ContactProfilesPropertiesProvisioningState provisioningState();

    /**
     * Gets the minimumViableContactDuration property: Minimum viable contact duration in ISO 8601 format. Used for
     * listing the available contacts with a spacecraft at a given ground station.
     * 
     * @return the minimumViableContactDuration value.
     */
    String minimumViableContactDuration();

    /**
     * Gets the minimumElevationDegrees property: Minimum viable elevation for the contact in decimal degrees. Used for
     * listing the available contacts with a spacecraft at a given ground station.
     * 
     * @return the minimumElevationDegrees value.
     */
    Float minimumElevationDegrees();

    /**
     * Gets the autoTrackingConfiguration property: Auto-tracking configuration.
     * 
     * @return the autoTrackingConfiguration value.
     */
    AutoTrackingConfiguration autoTrackingConfiguration();

    /**
     * Gets the eventHubUri property: ARM resource identifier of the Event Hub used for telemetry. Requires granting
     * Orbital Resource Provider the rights to send telemetry into the hub.
     * 
     * @return the eventHubUri value.
     */
    String eventHubUri();

    /**
     * Gets the networkConfiguration property: Network configuration of customer virtual network.
     * 
     * @return the networkConfiguration value.
     */
    ContactProfilesPropertiesNetworkConfiguration networkConfiguration();

    /**
     * Gets the thirdPartyConfigurations property: Third-party mission configuration of the Contact Profile. Describes
     * RF links, modem processing, and IP endpoints.
     * 
     * @return the thirdPartyConfigurations value.
     */
    List thirdPartyConfigurations();

    /**
     * Gets the links property: Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
     * 
     * @return the links value.
     */
    List links();

    /**
     * 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.orbital.fluent.models.ContactProfileInner object.
     * 
     * @return the inner object.
     */
    ContactProfileInner innerModel();

    /**
     * The entirety of the ContactProfile definition.
     */
    interface Definition
        extends DefinitionStages.Blank, DefinitionStages.WithLocation, DefinitionStages.WithResourceGroup,
        DefinitionStages.WithNetworkConfiguration, DefinitionStages.WithLinks, DefinitionStages.WithCreate {
    }

    /**
     * The ContactProfile definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the ContactProfile definition.
         */
        interface Blank extends WithLocation {
        }

        /**
         * The stage of the ContactProfile 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 ContactProfile 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.
             */
            WithNetworkConfiguration withExistingResourceGroup(String resourceGroupName);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify networkConfiguration.
         */
        interface WithNetworkConfiguration {
            /**
             * Specifies the networkConfiguration property: Network configuration of customer virtual network..
             * 
             * @param networkConfiguration Network configuration of customer virtual network.
             * @return the next definition stage.
             */
            WithLinks withNetworkConfiguration(ContactProfilesPropertiesNetworkConfiguration networkConfiguration);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify links.
         */
        interface WithLinks {
            /**
             * Specifies the links property: Links of the Contact Profile. Describes RF links, modem processing, and IP
             * endpoints..
             * 
             * @param links Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
             * @return the next definition stage.
             */
            WithCreate withLinks(List links);
        }

        /**
         * The stage of the ContactProfile 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.WithProvisioningState,
            DefinitionStages.WithMinimumViableContactDuration, DefinitionStages.WithMinimumElevationDegrees,
            DefinitionStages.WithAutoTrackingConfiguration, DefinitionStages.WithEventHubUri,
            DefinitionStages.WithThirdPartyConfigurations {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            ContactProfile create();

            /**
             * Executes the create request.
             * 
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            ContactProfile create(Context context);
        }

        /**
         * The stage of the ContactProfile 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 ContactProfile definition allowing to specify provisioningState.
         */
        interface WithProvisioningState {
            /**
             * Specifies the provisioningState property: The current state of the resource's creation, deletion, or
             * modification..
             * 
             * @param provisioningState The current state of the resource's creation, deletion, or modification.
             * @return the next definition stage.
             */
            WithCreate withProvisioningState(ContactProfilesPropertiesProvisioningState provisioningState);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify minimumViableContactDuration.
         */
        interface WithMinimumViableContactDuration {
            /**
             * Specifies the minimumViableContactDuration property: Minimum viable contact duration in ISO 8601 format.
             * Used for listing the available contacts with a spacecraft at a given ground station..
             * 
             * @param minimumViableContactDuration Minimum viable contact duration in ISO 8601 format. Used for listing
             * the available contacts with a spacecraft at a given ground station.
             * @return the next definition stage.
             */
            WithCreate withMinimumViableContactDuration(String minimumViableContactDuration);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify minimumElevationDegrees.
         */
        interface WithMinimumElevationDegrees {
            /**
             * Specifies the minimumElevationDegrees property: Minimum viable elevation for the contact in decimal
             * degrees. Used for listing the available contacts with a spacecraft at a given ground station..
             * 
             * @param minimumElevationDegrees Minimum viable elevation for the contact in decimal degrees. Used for
             * listing the available contacts with a spacecraft at a given ground station.
             * @return the next definition stage.
             */
            WithCreate withMinimumElevationDegrees(Float minimumElevationDegrees);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify autoTrackingConfiguration.
         */
        interface WithAutoTrackingConfiguration {
            /**
             * Specifies the autoTrackingConfiguration property: Auto-tracking configuration..
             * 
             * @param autoTrackingConfiguration Auto-tracking configuration.
             * @return the next definition stage.
             */
            WithCreate withAutoTrackingConfiguration(AutoTrackingConfiguration autoTrackingConfiguration);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify eventHubUri.
         */
        interface WithEventHubUri {
            /**
             * Specifies the eventHubUri property: ARM resource identifier of the Event Hub used for telemetry. Requires
             * granting Orbital Resource Provider the rights to send telemetry into the hub..
             * 
             * @param eventHubUri ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital
             * Resource Provider the rights to send telemetry into the hub.
             * @return the next definition stage.
             */
            WithCreate withEventHubUri(String eventHubUri);
        }

        /**
         * The stage of the ContactProfile definition allowing to specify thirdPartyConfigurations.
         */
        interface WithThirdPartyConfigurations {
            /**
             * Specifies the thirdPartyConfigurations property: Third-party mission configuration of the Contact
             * Profile. Describes RF links, modem processing, and IP endpoints..
             * 
             * @param thirdPartyConfigurations Third-party mission configuration of the Contact Profile. Describes RF
             * links, modem processing, and IP endpoints.
             * @return the next definition stage.
             */
            WithCreate
                withThirdPartyConfigurations(List thirdPartyConfigurations);
        }
    }

    /**
     * Begins update for the ContactProfile resource.
     * 
     * @return the stage of resource update.
     */
    ContactProfile.Update update();

    /**
     * The template for ContactProfile update.
     */
    interface Update extends UpdateStages.WithTags {
        /**
         * Executes the update request.
         * 
         * @return the updated resource.
         */
        ContactProfile apply();

        /**
         * Executes the update request.
         * 
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        ContactProfile apply(Context context);
    }

    /**
     * The ContactProfile update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the ContactProfile 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);
        }
    }

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @return the refreshed resource.
     */
    ContactProfile refresh();

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    ContactProfile refresh(Context context);
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy